From 78028693178e92005ee8ba5abf600fe30721c22a Mon Sep 17 00:00:00 2001 From: Jonathan Amsterdam Date: Mon, 30 Jun 2025 13:06:19 -0400 Subject: [PATCH 1/2] .github: add PR template The default template is too elaborate. Add a simpler one. --- .github/pull_request_template.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..e507c1fa --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +### PR Tips + +- The title should be "package: description". +For example, "mcp: rename LoggingMessage to Log". +For more pervasive changes, use "all" instead of a package name. + +- The commit message should provide context (why this commit?) and describe the changes + at a high level. Changes that are obvious from the diffs don't need to be mentioned. + +- Mention related issues with 'For #NNN' or 'Fixes #NNN' at the end of the commit message. + +- Look for PRs similar to yours in the log of this repo, or the Go repo (github.com/golang/go). From edd22c976e24f4d0770e5b0fa965323b368756e9 Mon Sep 17 00:00:00 2001 From: Jonathan Amsterdam Date: Mon, 30 Jun 2025 13:46:25 -0400 Subject: [PATCH 2/2] reviewer notes --- .github/pull_request_template.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e507c1fa..be13052c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,12 +1,12 @@ ### PR Tips -- The title should be "package: description". -For example, "mcp: rename LoggingMessage to Log". -For more pervasive changes, use "all" instead of a package name. +Typically, PRs should consist of a single commit, and so should generally follow +the [rules for Go commit messages](https://go.dev/wiki/CommitMessage), with the following +changes and additions: -- The commit message should provide context (why this commit?) and describe the changes - at a high level. Changes that are obvious from the diffs don't need to be mentioned. +- Markdown is allowed. -- Mention related issues with 'For #NNN' or 'Fixes #NNN' at the end of the commit message. +- For a pervasive change, use "all" in the title instead of a package name. -- Look for PRs similar to yours in the log of this repo, or the Go repo (github.com/golang/go). +- The PR description should provide context (why this change?) and describe the changes + at a high level. Changes that are obvious from the diffs don't need to be mentioned.