Update PULL_REQUEST_TEMPLATE.md #574
Merged
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
MSalopek
approved these changes
Dec 8, 2022
|
|
||
| # How was the feature tested? | ||
|
|
||
| - [ ] Unit tests |
There was a problem hiding this comment.
maybe leave this in? Not sure if people are using it. If not, just delete :D
There was a problem hiding this comment.
Imo "how was this feature tested" is too broad. GH already shows you below which types of tests are passing or failing, and there's info in the main README about what each type of test is useful for.
The most important PR considerations in my mind are:
- what new or existing tests are acting as regression tests
- what new or existing tests are validating new behavior.
Just my two cents :), not trying to take things away that people like
shaspitz
commented
Dec 8, 2022
shaspitz
requested review from
jtremback,
mpoke,
sainoe and
danwt
as code owners
jtremback
approved these changes
Dec 13, 2022
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.
Inspired by a talk @MSalopek and I just had. Only include things that're neccessary, merge agreements etc. should be defined elsewhere or enforced by reviewers and GH rules.
The
Type of Changesection will be important in reducing the effort it takes to review PRs. If a PR is aFeatureandRefactorfor example, this template will explicitly call out that the changes should likely be split up.