-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5c40800
commit 4043e8e
Showing
3 changed files
with
33 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,25 @@ | ||
<!-- | ||
This source file is part of the Stanford CS342 - Building for Digital Health class | ||
SPDX-FileCopyrightText: 2022 Stanford University | ||
SPDX-License-Identifier: MIT | ||
--> | ||
|
||
# *Name of the PR* | ||
|
||
## :recycle: Current situation & Problem | ||
*Describe the current situation (if possible, with an exemplary (or real) code snippet and/or where this is used)* | ||
*Please link any open issue that is addressed with this PR* | ||
*Link any open issues or pull requests (PRs) related to this PR. Please ensure that all non-trivial PRs are first tracked and discussed in an existing GitHub issue or discussion.* | ||
|
||
## :bulb: Proposed solution | ||
*Describe the solution and how this affects the project and internal structure* | ||
|
||
## :gear: Release Notes | ||
*Add a summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.* | ||
*Include code snippets that provide examples of the feature implemented if it appends or changes the public interface.* | ||
*Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.* | ||
*Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.* | ||
|
||
|
||
## :heavy_plus_sign: Additional Information | ||
*Provide some additional information if possible* | ||
## :books: Documentation | ||
*Please ensure that you properly document any additions in conformance to [Spezi Documentation Guide](https://github.com/StanfordSpezi/.github/blob/main/DOCUMENTATIONGUIDE.md).* | ||
*You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.* | ||
|
||
### Related PRs | ||
*Reference the related PRs* | ||
|
||
### Testing | ||
*Are there tests included? If yes, which situations are tested, and which corner cases are missing?* | ||
## :white_check_mark: Testing | ||
*Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.* | ||
*This section describes important information about the tests and why some elements might not be testable.* | ||
|
||
### Reviewer Nudging | ||
*Where should the reviewer start? Where is a good entry point?* | ||
|
||
### Code of Conduct & Contributing Guidelines | ||
## :pencil: Code of Conduct & Contributing Guidelines | ||
|
||
By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md): | ||
- [ ] I agree to follow the [Code of Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
This source file is part of the Stanford CS342 - Building for Digital Health class | ||
|
||
SPDX-FileCopyrightText: 2022 Stanford University | ||
|
||
SPDX-License-Identifier: MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters