-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Add a pull request template #963
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
94ed66b
Create pull_request_template.md
coilysiren a655beb
Update .github/pull_request_template.md
coilysiren 94f600f
cleanup formatting
coilysiren b2a974e
remove out of scope section
coilysiren dad0680
Add release notes section
coilysiren 0859d8f
Merge branch 'master' into pr-template
coilysiren File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,56 @@ | ||
| <!-- | ||
| This template provides some ideas of things to include in your PR description. | ||
| To start, try providing a short summary of your changes in the Title above. | ||
| If a section of the PR template does not apply to this PR, then delete that section. | ||
| --> | ||
|
|
||
| ## Motivation | ||
|
|
||
| _(fill-in or delete this section)_ | ||
|
|
||
| <!-- | ||
| What goal is this change working towards? | ||
| If this PR fixes one of more issues, list them here. | ||
| One line each, like so: | ||
| Fixes #123 | ||
| Fixes #39 | ||
| --> | ||
|
|
||
| ## Release Notes | ||
|
|
||
| _(fill-in or delete this section)_ | ||
|
|
||
| <!-- | ||
| If this PR makes user facing changes, please describe them here. | ||
| This description will be copied into the release notes, whenever | ||
| the next version is released. Keep this section short, and | ||
| focus on high level changes. | ||
| --> | ||
|
|
||
| ## Changes | ||
|
|
||
| _(fill-in or delete this section)_ | ||
|
|
||
| <!-- | ||
| Provide a bullet pointed summary of how each file was changed. | ||
| Briefly explain any decisions you made with respect to the changes. | ||
| Include anything here that you didn't include in *Release Notes* | ||
| above, such as changes to CI or changes to internal methods. | ||
| --> | ||
|
|
||
| ## Testing | ||
|
|
||
| _(fill-in or delete this section)_ | ||
|
|
||
| <!-- | ||
| Describe how you tested this change. | ||
| --> | ||
|
|
||
| ## Reviewer Guidelines | ||
|
|
||
| _(fill-in or delete this section)_ | ||
|
|
||
| <!-- | ||
| Is there any particular feedback you would / wouldn't like? | ||
| Which parts of the code should reviewers focus on? | ||
| --> | ||
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.
Uh oh!
There was an error while loading. Please reload this page.