Skip to content

GEMINI.md: keep PR descriptions to bookkeeping #638

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
justinsb merged 1 commit into from
Oct 7, 2026
Merged

GEMINI.md: keep PR descriptions to bookkeeping #638

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions GEMINI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ The `gateway-api-reference-implementation` is intended to be a simple, pure Go,
- Well-structured commits.
- Reference issues in the commit body.

### Commit messages and PR descriptions

The git history is the permanent record; the GitHub PR description is not. It is not part of the merged artifact and is effectively lost after merge.

- **Put anything worth keeping in the code or the commits**: design decisions and non-obvious behaviour belong in code comments; the reasoning behind a change belongs in the commit message.
- **Keep the PR description to bookkeeping**: normally just `Fixes #<issue>`. Don't summarize or "sell" the change; the code and commits should stand on their own.
- When you revise a PR in response to review, don't maintain a changelog in the PR description.

### Commands

The project uses the `ap` tool for various tasks. Since `ap` is a custom tool, it should be run using `go run`:
Expand Down
Loading