chore: add pr description template #230
Open
+146
−0
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
YunchuWang
requested review from
vrdmr,
gavin-aguiar,
pdthummar and
hallvictoria
as code owners
vrdmr
requested changes
Jul 1, 2024
| - [ ] **When/Where Not to Log**: Verify that logging is not excessive, does not occur in performance-sensitive areas, avoids redundancy, and does not include temporary data. | ||
| - [ ] **Actionable Urgent Logs**: Ensure urgent logs provide clear follow-up actions, such as links to documentation, next steps, or contact information. | ||
|
|
||
| ### Design Patterns & Implementation |
There was a problem hiding this comment.
Can this go into Contributor Guidelines? Rather than in the PR description?
| - [ ] 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 | ||
|
|
||
| ## Reviewer Checklist |
There was a problem hiding this comment.
I liked this pattern - helping reviewer checklist is important as well.
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] 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 |
There was a problem hiding this comment.
Make it explicit for our case as well - new tests added for new feature, new is this going to be an opt-in feature at first or out-out? etc.
hallvictoria
reviewed
Jul 1, 2024
| - [ ] Bug fix | ||
| - [ ] New feature | ||
| - [ ] Breaking change | ||
| - [ ] Documentation update |
There was a problem hiding this comment.
Maybe have an "Other" option -- thinking about adding tests, removing dead code, etc
hallvictoria
reviewed
Jul 1, 2024
| - [ ] I have made corresponding changes to the documentation | ||
| - [ ] My changes generate no new warnings | ||
| - [ ] 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 |
There was a problem hiding this comment.
nit: "New and existing tests pass locally with my changes"
All new and existing tests should pass, not just unit tests
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.
No description provided.