-
Notifications
You must be signed in to change notification settings - Fork 1
SRE-1110: Create pull request template #113
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TimDiekmann
wants to merge
1
commit into
main
Choose a base branch
from
t/sre-1110-add-an-org-wide-default-pull-request-template-to
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
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,35 @@ | ||
| ## 馃専 Purpose | ||
|
|
||
| <!-- | ||
| Required. Must be written by a human, as short sentences or bullets. | ||
| -> Why are you making this change? Start with the problem or request, e.g. "The frontend fails on X because Y." | ||
| -> Then say in a few sentences what the PR does. | ||
| -> Link a doc or discussion the reader needs for context, don't include link to PRs which PR is stacked on, and don't add links to this linear issue (if multiple linear issues are done as part of this PR, include them all in a comma-separated list in the PR title). | ||
| -> For a UI change, add a screenshot or recording here, and the steps to see it working. | ||
| -> Do not reveal internal client or security-specific motivations in the description. | ||
| --> | ||
|
|
||
| ## 馃攳 Changes | ||
|
|
||
| <!-- | ||
| Required unless the purpose already says everything that changed, delete this section otherwise. | ||
| -> What should a reviewer know before opening the diff? | ||
| -> Pick the most important changes that matter, say why anything surprising changed, and for a big PR, where to start. | ||
| -> don't list every file or function you changed | ||
| -> This section should help the reviewer to understand changes that won't be self-evident from reading down the diff, either because they span multiple files, are complex, or would seem unconnected to the primary goal. | ||
| -> Do not reveal internal client or security-specific changes. | ||
| --> | ||
|
|
||
| ## 鈿狅笍 Known issues | ||
|
|
||
| <!-- | ||
| Required if something is broken, unfinished or breaking, e.g. it's behind a feature flag or the fix comes next. Delete this section otherwise. | ||
| -> Do not reveal internal client or security-specific issues. | ||
| --> | ||
|
|
||
| ## 馃毇 Blocked by | ||
|
|
||
| <!-- | ||
| Describe anything that must be done before the PR is merged, for example further testing, deployment of something, etc. Delete this section otherwise. | ||
| -> Never include dependencies that are already obvious in GitHub (stacked branches). | ||
| --> | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did like the "how to test this"/"Demo" section. Can we add it and make it commented out by default perhaps?
The Linear issue talks about this potentially replacing the other templates in the main repo, is that something you expect?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you raise this in this slack thread? We have the context there already.