feat: add Pull Request template #241
There are no files selected for viewing
This file contains hidden or 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,32 @@ | ||||||||||||||
| # Description | ||||||||||||||
|
|
||||||||||||||
| Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. | ||||||||||||||
|
|
||||||||||||||
| Fixes # | ||||||||||||||
|
|
||||||||||||||
|
|
||||||||||||||
| # Type of change | ||||||||||||||
|
|
||||||||||||||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||||||||||||||
| - [ ] New feature (non-breaking change which adds functionality) | ||||||||||||||
| - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||||||||||||||
| - [ ] This change requires a documentation update | ||||||||||||||
|
|
||||||||||||||
| # How Has This Been Tested? | ||||||||||||||
|
|
||||||||||||||
| Please describe the tests that you ran to verify your changes. | ||||||||||||||
|
|
||||||||||||||
| - [ ] Test A | ||||||||||||||
| - [ ] Test B | ||||||||||||||
|
Comment on lines
+15
to
+20
Contributor
There was a problem hiding this comment.
Suggested change
For this project, I think the test suite should cover things. Tests should be added if needed, but that is covered by the checklist. |
||||||||||||||
|
|
||||||||||||||
| # Checklist | ||||||||||||||
|
|
||||||||||||||
| _Please check all that apply. You can mark items as N/A if they don't apply to your change._ | ||||||||||||||
|
|
||||||||||||||
| - [ ] My code follows the style guidelines of this project | ||||||||||||||
| - [ ] I have performed a self-review of my own code | ||||||||||||||
| - [ ] I have commented my code, particularly in hard-to-understand areas | ||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||
| - [ ] I have made corresponding changes to the documentation | ||||||||||||||
| - [ ] My changes generate no new warnings | ||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
We'll have to add a bot which indicates any new warnings, seems more reliable than self-reporting. We'll do this separately. |
||||||||||||||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||||||||||||||
| - [ ] New and existing unit tests pass locally with my changes | ||||||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.