Skip to content

Commit edd22c9

Browse files
committed
reviewer notes
1 parent 7802869 commit edd22c9

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
### PR Tips
22

3-
- The title should be "package: description".
4-
For example, "mcp: rename LoggingMessage to Log".
5-
For more pervasive changes, use "all" instead of a package name.
3+
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:
66

7-
- The commit message should provide context (why this commit?) and describe the changes
8-
at a high level. Changes that are obvious from the diffs don't need to be mentioned.
7+
- Markdown is allowed.
98

10-
- Mention related issues with 'For #NNN' or 'Fixes #NNN' at the end of the commit message.
9+
- For a pervasive change, use "all" in the title instead of a package name.
1110

12-
- Look for PRs similar to yours in the log of this repo, or the Go repo (github.com/golang/go).
11+
- The PR description should provide context (why this change?) and describe the changes
12+
at a high level. Changes that are obvious from the diffs don't need to be mentioned.

0 commit comments

Comments
 (0)