Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial setup of repository #2

Merged
merged 13 commits into from
Nov 20, 2023
Merged

Initial setup of repository #2

merged 13 commits into from
Nov 20, 2023

Conversation

philippzagar
Copy link
Member

Initial setup of repository

♻️ Current situation & Problem

Currently, the repo is mostly empty except for a template package.

⚙️ Release Notes

  • Initial setup of the SpeziChat repo which previously was a target in the SpeziML repo
  • Improved README and documentation via DocC

📚 Documentation

--

✅ Testing

UI Tests are included

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

@philippzagar philippzagar added the enhancement New feature or request label Nov 13, 2023
@philippzagar philippzagar self-assigned this Nov 13, 2023
Copy link

codecov bot commented Nov 13, 2023

Codecov Report

Merging #2 (6008500) into main (0e0ff11) will decrease coverage by 13.02%.
The diff coverage is 86.98%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##              main       #2       +/-   ##
============================================
- Coverage   100.00%   86.98%   -13.02%     
============================================
  Files            1        6        +5     
  Lines            1      261      +260     
============================================
+ Hits             1      227      +226     
- Misses           0       34       +34     
Files Coverage Δ
Sources/SpeziChat/MessageView.swift 100.00% <100.00%> (ø)
Sources/SpeziChat/Models/ChatEntity.swift 100.00% <100.00%> (ø)
Sources/SpeziChat/MessageInputViewHeightKey.swift 50.00% <50.00%> (ø)
Sources/SpeziChat/MessagesView.swift 90.75% <90.75%> (ø)
Sources/SpeziChat/ChatView.swift 77.42% <77.42%> (ø)
Sources/SpeziChat/MessageInputView.swift 82.73% <82.73%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e0ff11...6008500. Read the comment docs.

@philippzagar
Copy link
Member Author

@PSchmiedmayer Same as in StanfordSpezi/SpeziSpeech#2, I think what's left here is a proper DOI as well as the push to the Swift Package Index (the latter one can probably only be done after merging to main, the links to the index are already set correctly, that's thy the Markdown Link Check fails).

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding the code to this repo from Spezi ML and adding all the documentation surrounding it!

Similar to the Speech PR; I had a few comments that would be great to be addressed before we merge the PR.

The overall PR looks very great and all the documentation added is more than appreciated! 🚀

.github/workflows/build-and-test.yml Outdated Show resolved Hide resolved
.github/workflows/pull_request.yml Outdated Show resolved Hide resolved
CITATION.cff Outdated Show resolved Hide resolved
CONTRIBUTORS.md Show resolved Hide resolved
Package.swift Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Sources/SpeziChat/SpeziChat.docc/SpeziChat.md Outdated Show resolved Hide resolved
Tests/UITests/TestApp/ChatTestView.swift Outdated Show resolved Hide resolved
@philippzagar
Copy link
Member Author

@PSchmiedmayer PR is ready for another round of review. The only left TODO will be incorporated once SpeziSpeech is merged and tagged.

Copy link
Member

@PSchmiedmayer PSchmiedmayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @philippzagar; this looks great!

@philippzagar
Copy link
Member Author

@PSchmiedmayer Similar to https://github.com/StanfordSpezi/SpeziSpeech, please merge the PR and tag a release :)

@PSchmiedmayer PSchmiedmayer merged commit b8f84de into main Nov 20, 2023
6 of 9 checks passed
@PSchmiedmayer PSchmiedmayer deleted the feat/init-setup branch November 20, 2023 17:05
@PSchmiedmayer
Copy link
Member

Thank you for all the setup here @philippzagar! I have merged the PR, tagged a release, and it should also start the process of creating a DOI for the repo.

Feel free to create a similar PR to Spezi Speech once all the processes are finished. Thank you for all the work in setting these things up!

@philippzagar
Copy link
Member Author

Thanks @PSchmiedmayer, will add the DOI as well as SPI things soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants