Skip to content

.github: add PR template #75

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025
Merged

.github: add PR template #75

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7802869
.github: add PR template
jba Jun 30, 2025
edd22c9
reviewer notes
jba Jun 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Copy link
Contributor

@findleyr findleyr Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/commit message/PR description?

Maybe say: "typically, PRs should consist of a single commit, and so should generally follow the rules for Go commit messages: https://go.dev/wiki/CommitMessage"

Copy link
Contributor Author

@jba jba Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor Author

@jba jba Jun 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requires another approval

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).
Loading