docs: update PR template #823
Open
Conversation
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
rg936672
approved these changes
Oct 25, 2024
There was a problem hiding this comment.
Looks good. I'd suggest replacing the "I have commented my code" check in the checklist with something more like "I have ensured my code is easy to understand, including adding docstrings and using comments where necessary", since some changes just don't really require comments.
tp832944
reviewed
Oct 25, 2024
| Test A: (Write your answer here.) | ||
| Test B: (Write your answer here.) | ||
| Test C: (Write your answer here.) | ||
| (Write your answer here, or delete as appropriate.) |
There was a problem hiding this comment.
Can we remove these lines that need to be deleted by the user?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Type
Description
This PR updates the template for future PRs, in light of inefficiencies and disengagement with certain pre-existing sections.
How Has This Been Tested?
Existing tests pass.
Does this PR introduce a breaking change?
No.
(Write your answer here.)
Checklist before requesting a review