Skip to content

docs: document the issue-reference footer format #520

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
scottmries merged 5 commits into from
Oct 7, 2026
Merged

docs: document the issue-reference footer format #520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea0dc61
docs: document the issue-reference footer format
scottmries Oct 1, 2026
8063cf5
docs: use a commented placeholder for the issue footer
scottmries Oct 2, 2026
b33e206
docs: drop the CLAUDE.md import shim
scottmries Oct 2, 2026
26557fc
docs: state the footer rule in one line
scottmries Oct 2, 2026
e9bf16f
docs: stop restating the footer rule in the PR template
scottmries Oct 2, 2026
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
6 changes: 6 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,6 @@
## Details

<!-- A sentence or two describing what this PR changes. -->

<!-- The last line must reference the issue; see AGENTS.md. -->
<!-- Closes: #123 -->
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The last line of a pull request description is its footer: write it exactly as `Closes: #123`, one issue per line with nothing below it and no word between the keyword and the number (`Closes issue #123` renders as a working link but never closes the issue) — or `Ref: #123` to reference without closing, `No QA required` when there is no issue.
Loading