Skip to content

Commit 679f777

Browse files
Update pull_request_template.md (#287)
pull_request_template: update template to reflect correct form
1 parent dae8853 commit 679f777

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

.github/pull_request_template.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,28 @@
1-
### PR Tips
1+
### PR Guideline
22

33
Typically, PRs should consist of a single commit, and so should generally follow
4-
the [rules for Go commit messages](https://go.dev/wiki/CommitMessage), with the following
5-
changes and additions:
4+
the [rules for Go commit messages](https://go.dev/wiki/CommitMessage).
65

7-
- Markdown is allowed.
6+
You **must** follow the form:
87

9-
- For a pervasive change, use "all" in the title instead of a package name.
8+
```
9+
net/http: handle foo when bar
10+
11+
[longer description here in the body]
12+
13+
Fixes #12345
14+
```
15+
Notably, for the subject (the first line of description):
1016

17+
- the name of the package affected by the change goes before the colon
18+
- the part after the colon uses the verb tense + phrase that completes the blank in, “this change modifies this package to ___________
19+
- the verb after the colon is lowercase
20+
- there is no trailing period
21+
- it should be kept as short as possible
22+
23+
Additionally:
24+
25+
- Markdown is allowed.
26+
- For a pervasive change, use "all" in the title instead of a package name.
1127
- The PR description should provide context (why this change?) and describe the changes
1228
at a high level. Changes that are obvious from the diffs don't need to be mentioned.

0 commit comments

Comments
 (0)