Adds a PR template #2764
Merged
Adds a PR template #2764
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
boutell
requested changes
Mar 1, 2021
.github/pull_request_template.md
Outdated
|
|
||
| - [ ] Link to the related issue with requirements and/or clearly describe 1) what problem this solves and 2) the requirements to review it against. | ||
| - [ ] Update the `CHANGELOG.md` file with the added feature or fix. If there is not yet a heading for an upcoming release, add one following the established pattern. | ||
| - [ ] Keep the pull request minimal! Break large updates into separate pull requests whenever possible. Small requests get reviewed more quickly. |
There was a problem hiding this comment.
As long as they make sense independently and can be tested independently.
| - [ ] Link to the related issue with requirements and/or clearly describe 1) what problem this solves and 2) the requirements to review it against. | ||
| - [ ] Update the `CHANGELOG.md` file with the added feature or fix. If there is not yet a heading for an upcoming release, add one following the established pattern. | ||
| - [ ] Keep the pull request minimal! Break large updates into separate pull requests whenever possible. Small requests get reviewed more quickly. | ||
|
|
There was a problem hiding this comment.
- Follow our style guide. Most modules have an eslint configuration, so you can run
npx eslint .in the module if your editor does not automatically pick up on that.
boutell
requested changes
Mar 1, 2021
| @@ -2,6 +2,7 @@ Please ensure your pull request follows these guidelines: | |||
|
|
|||
| - [ ] Link to the related issue with requirements and/or clearly describe 1) what problem this solves and 2) the requirements to review it against. | |||
| - [ ] Update the `CHANGELOG.md` file with the added feature or fix. If there is not yet a heading for an upcoming release, add one following the established pattern. | |||
| - [ ] Keep the pull request minimal! Break large updates into separate pull requests whenever possible. Small requests get reviewed more quickly. | |||
| - [ ] Keep the pull request minimal! Break large updates into separate pull requests for individual features/fixes whenever possible. Small requests get reviewed more quickly. | |||
| - [ ] All tests must pass, including the linters. Run `npm run lint` to test code linting independently. | |||
There was a problem hiding this comment.
If the module does not yet have a lint task please adhere to the formatting style in place.
There was a problem hiding this comment.
@boutell This is a template only for core, which has the linter test.
boutell
approved these changes
Mar 2, 2021
Merged
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 template meant primarily to help us remember to update the changelog and keep changes manageable.