swiftpackagetemplate
A Template Repository for a Swift Package-based Stanford Byers Center for Biodesign Digital Health Project
Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.6%) to scientific vocabulary
Keywords
Repository
A Template Repository for a Swift Package-based Stanford Byers Center for Biodesign Digital Health Project
Basic Info
- Host: GitHub
- Owner: StanfordBDHG
- License: mit
- Language: Swift
- Default Branch: main
- Homepage: https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate/documentation
- Size: 62.5 KB
Statistics
- Stars: 17
- Watchers: 12
- Forks: 1
- Open Issues: 4
- Releases: 6
Topics
Metadata Files
README.md
TemplatePackage
How To Use This Template
The template repository contains a template Swift Package, including a continuous integration setup.
Follow these steps to customize it to your needs:
1. Rename the Swift Package. Be sure that you update the name in the build-and-test.yml GitHub Action accordingly. If you have multiple targets in your Swift Package, you need to pass the name of the Swift Package followed by an -Package as the scheme to the GitHub Action, e.g., StanfordProject-Package if your Swift Package is named StanfordProject.
2. If your Swift Package does not provide any user interface or does not require an iOS application environment to function, you can remove the UITests application from the Tests folder. You need to update the build-and-test.yml GitHub Action accordingly by removing the GitHub Action that builds and tests the application, removing the dependency from the code coverage upload step, and removing the UI test .xresult input from the code coverage test.
3. If your Swift Package uses UI test, you need to ...
- ... add it to the scheme editor (Scheme > Edit Scheme) and your targets to the "Build" configuration and ensure that it is built before the test app target when building for the "Test" configuration. It is not required to enable building for other configurations like "Analyze", "Run", "Profile", or "Archive".
- ... add it as a linked framework in the main target configuration (In your Xcode project settings, select your test app target > General > Frameworks, Libraries, and Embedded Comments).
- ... add ensure that the targets are all added in the code coverage settings of your .xctestplan file in the Xcode Project (Shared Settings > Code Coverage > Code Coverage).
4. You will either need to add the CodeCov GitHub App or add a codecov.io token to your GitHub Actions Secrets following the instructions of the Codecov GitHub Action. The StanfordBDHG organization already has the CodeCov GitHub App installed. If you do not want to cover test coverage data, you can remove the code coverage job in the build-and-test.yml GitHub Action.
5. Adjust this README.md to describe your project and adjust the badges at the top to point to the correct GitHub Action of your repository and Codecov badge.
6. The Swift Package template includes a Swift Package Index configuration file to automatically build the package and host the documentation on the Swift Package Index website. Adjust the .spi.yml file to include all targets that you want to build documentation for. You can follow the instructions of the Swift Package Index to include your Swift Package in the Swift Package Index. You can link to the API documentation from your README file.
7. Adjust the CITATION.cff file to amend information about the new Swift Package (learn more about CITATION files on GitHub) and register the Swift Package on Zenodo.
Installation
The project can be added to your Xcode project or Swift Package using the Swift Package Manager.
Xcode: For an Xcode project, follow the instructions on adding package dependencies to your app.
Swift Package: You can follow the Swift Package Manager documentation about defining dependencies to add this project as a dependency to your Swift Package.
License
This project is licensed under the MIT License. See Licenses for more information.
Contributors
This project is developed as part of the Stanford Byers Center for Biodesign at Stanford University. See CONTRIBUTORS.md for a full list of all TemplatePackage contributors.
Owner
- Name: Stanford Biodesign Digital Health
- Login: StanfordBDHG
- Kind: organization
- Location: United States of America
- Twitter: StanfordBDHG
- Repositories: 18
- Profile: https://github.com/StanfordBDHG
Citation (CITATION.cff)
# # This source file is part of the TemplatePackage open source project # # SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md) # # SPDX-License-Identifier: MIT # cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Schmiedmayer" given-names: "Paul" orcid: "https://orcid.org/0000-0002-8607-9148" - family-names: "Ravi" given-names: "Vishnu" orcid: "https://orcid.org/0000-0003-0359-1275" title: "TemplatePackage" doi: 10.5281/zenodo.7538165 url: "https://github.com/StanfordBDHG/SwiftPackageTemplate"
GitHub Events
Total
- Create event: 3
- Issues event: 1
- Release event: 3
- Watch event: 4
- Delete event: 3
- Member event: 2
- Issue comment event: 2
- Push event: 6
- Pull request review comment event: 5
- Pull request event: 4
- Pull request review event: 5
Last Year
- Create event: 3
- Issues event: 1
- Release event: 3
- Watch event: 4
- Delete event: 3
- Member event: 2
- Issue comment event: 2
- Push event: 6
- Pull request review comment event: 5
- Pull request event: 4
- Pull request review event: 5
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 16
- Total Committers: 2
- Avg Commits per committer: 8.0
- Development Distribution Score (DDS): 0.063
Top Committers
| Name | Commits | |
|---|---|---|
| Paul Schmiedmayer | P****r@u****m | 15 |
| Vishnu Ravi | v****i@g****m | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 18
- Average time to close issues: N/A
- Average time to close pull requests: 6 days
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 1.39
- Merged pull requests: 15
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 11 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 1.67
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- PSchmiedmayer (2)
- philippzagar (1)
Pull Request Authors
- PSchmiedmayer (12)
- Supereg (6)
- vishnuravi (3)
- lukaskollmer (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
swiftpackageindex.com: github.com/StanfordBDHG/SwiftPackageTemplate
A Template Repository for a Swift Package-based Stanford Byers Center for Biodesign Digital Health Project
- Homepage: https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate/documentation
- Documentation: https://swiftpackageindex.com/StanfordBDHG/SwiftPackageTemplate/documentation
- License: mit
-
Latest release: 0.3.0
published over 1 year ago