Skip to content

Commit d8317a9

Browse files
committed
github: add PR template
1 parent fa0d658 commit d8317a9

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Thank you for your PR. Please follow the below rules to ensure a swift review.
2+
3+
1. Read and follow the guidelines for contributing here:
4+
https://github.com/grpc/grpc-go/blob/master/CONTRIBUTING.md
5+
6+
Note: if you are submitting a PR that does not address an open issue with an
7+
agreed resolution, it is much more likely your PR will be rejected.
8+
9+
2. Read and follow the guidelines for PR titles and descriptions here:
10+
https://google.github.io/eng-practices/review/developer/cl-descriptions.html
11+
12+
3. PR titles should start with the name of the component being addressed, or the
13+
type of change. Examples: transport, client, server, round_robin, xds,
14+
cleanup, deps.
15+
16+
4. Does this PR relate to an open issue? On the first line, please use the tag
17+
`Fixes #<issue>` to ensure the issue is closed when the PR is merged. Or use
18+
`Updates #<issue>` if the PR is related to an open issue, but does not fix
19+
it. Consider filing an issue if one does not already exist.
20+
21+
5. PR descriptions _must_ conclude with release notes as follows:
22+
23+
```
24+
RELEASE NOTES:
25+
* <componenet>: <summary>
26+
```
27+
28+
This need not match the PR title.
29+
30+
The summary must:
31+
32+
* be something that gRPC users will understand.
33+
34+
* clearly explain the feature being added, the issue being fixed, or the
35+
behavior being changed, etc. If fixing a bug, be clear about how the bug
36+
can be triggered by an end-user.
37+
38+
* begin with a capital letter and use complete sentences.
39+
40+
* be as short as possible to describe the change being made.
41+
42+
If a PR is not end-user visible -- e.g. a cleanup, testing change, or
43+
github-related, use `RELEASE NOTES: n/a`.
44+
45+
6. Self-review your code changes before sending your PR.
46+
47+
7. Delete all of the above before sending your PR.

0 commit comments

Comments
 (0)