ainur/metube
1
0
Fork 0
mirror of https://github.com/alexta69/metube.git synced 2026-09-21 13:35:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: put the closing keyword in the commit subject

Browse Source 
GitHub matches a closing keyword anywhere in the message, so the previous
"on its own line in the body" rule was invented. Use the parenthesised subject
form instead: "fix: ... (closes #1040)".
This commit is contained in:
Alex Shnitman
2026-07-27 23:13:07 +03:00
parent 6551f7ad58
commit 0445f5858b
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+11 -5
View File
@@ -98,11 +98,17 @@ fixes.
## Commit messages ## Commit messages
A commit that resolves an issue must close it, using GitHub's `Closes #N.` on its A commit that resolves an issue must close it, with a GitHub closing keyword in
own line in the commit body. Because master is the default branch and is released parentheses at the end of the subject line:
on every push, the issue closes at the moment the fix ships, and the issue keeps a
permanent link to the commit that fixed it. A bare `(#123)` in the subject only ```
creates a reference — and reads as a pull-request number — so it does not count. fix: stop metadata probes from writing playlist sidecar files (closes #1040)
```
Because master is the default branch and is released on every push, the issue
closes at the moment the fix ships, and keeps a permanent link to the commit that
fixed it. A bare `(#1040)` is only a reference — and reads as a pull-request
number — so it does not count; the keyword is what closes the issue.
Auto-closing leaves only a commit stub on the issue, which is not an answer to Auto-closing leaves only a commit stub on the issue, which is not an answer to
whoever reported it. Post an explanatory comment as well: what the cause was, what whoever reported it. Post an explanatory comment as well: what the cause was, what