From e5bdd5564ac818b4327e32e78ee3270924baa26e Mon Sep 17 00:00:00 2001 From: justinsb Date: Tue, 6 Oct 2026 19:51:26 -0400 Subject: [PATCH] GEMINI.md: keep PR descriptions to bookkeeping The PR description is not part of the merged artifact, so important details written there are lost after merge. Ask agents to put design notes in code comments and reasoning in commit messages, and to keep the PR description to something like "Fixes #123". --- GEMINI.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/GEMINI.md b/GEMINI.md index 0d68cf8..23af267 100644 --- a/GEMINI.md +++ b/GEMINI.md @@ -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 #`. 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`: