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

Documentation & Setup Improvements #59

Merged
merged 21 commits into from
Jan 11, 2024
Merged

Documentation & Setup Improvements #59

merged 21 commits into from
Jan 11, 2024

Conversation

PSchmiedmayer
Copy link
Member

@PSchmiedmayer PSchmiedmayer commented Jan 10, 2024

Documentation & Setup Improvements

⚙️ Release Notes

  • Adds a DocC-based Documentation to host articles and inline-documentation about different parts of the template application.
  • Adds a setup script to automatically install all the necessary tools and software elements to use the Spezi Template Application.
  • Adds DocC articles to address part of Documentation Improvements #55:
    • Setup your development environment
    • Change the template application to fit your project needs
    • Modify the application and point to relevant Spezi Modules

📝 Code of Conduct & Contributing Guidelines

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

@PSchmiedmayer PSchmiedmayer added the documentation Improvements or additions to documentation label Jan 10, 2024
@PSchmiedmayer PSchmiedmayer self-assigned this Jan 10, 2024
Copy link

codecov bot commented Jan 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (82bda2a) 80.54% compared to head (e9eb7a7) 80.65%.

❗ Current head e9eb7a7 differs from pull request most recent head e0842c8. Consider uploading reports for the commit e0842c8 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   80.54%   80.65%   +0.12%     
==========================================
  Files          31       33       +2     
  Lines         976      961      -15     
==========================================
- Hits          786      775      -11     
+ Misses        190      186       -4     
Files Coverage Δ
TemplateApplication/Account/AccountButton.swift 100.00% <ø> (ø)
...mplateApplication/Account/AccountSetupHeader.swift 100.00% <ø> (ø)
TemplateApplication/Account/AccountSheet.swift 95.66% <ø> (ø)
TemplateApplication/Contacts/Contacts.swift 91.84% <ø> (ø)
...eApplication/Contributions/ContributionsList.swift 100.00% <ø> (ø)
...pplication/Contributions/Package+LicenseType.swift 83.73% <ø> (ø)
...emplateApplication/Contributions/PackageCell.swift 86.49% <ø> (ø)
...plateApplication/Contributions/PackageHelper.swift 63.64% <ø> (ø)
TemplateApplication/Helper/Binding+Negate.swift 100.00% <ø> (ø)
TemplateApplication/Helper/Bundle+Image.swift 0.00% <ø> (ø)
... and 23 more

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 82bda2a...e0842c8. Read the comment docs.

@PSchmiedmayer PSchmiedmayer merged commit 81b34a2 into main Jan 11, 2024
3 of 4 checks passed
@PSchmiedmayer PSchmiedmayer deleted the feature/setup branch January 11, 2024 09:43
@PSchmiedmayer PSchmiedmayer mentioned this pull request Jan 11, 2024
6 tasks
@vishnuravi vishnuravi mentioned this pull request Mar 24, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant