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: require Closes #N in commits that resolve an issue

Browse Source 
Master is the default branch and is released on every push, so a commit body
that says "Closes #N." makes the issue close exactly when the fix ships and
leaves a permanent link from the issue to the commit — instead of a separate
manual close afterwards. Notes that a bare (#123) in the subject is only a
reference, and that auto-closing still needs an explanatory comment on the
issue.
This commit is contained in:
Alex Shnitman
2026-07-27 23:09:58 +03:00
parent 06c63ec6e5
commit 6551f7ad58
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+11 -1
View File
@@ -96,7 +96,17 @@ release the same day. **Master is continuously released** — a PR must be
release-ready exactly as merged; there is no stabilization window for follow-up release-ready exactly as merged; there is no stabilization window for follow-up
fixes. fixes.
## Code style ## Commit messages
A commit that resolves an issue must close it, using GitHub's `Closes #N.` on its
own line in the commit body. Because master is the default branch and is released
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.
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
changed, and anything the reporter needs to do differently.
Follow `.editorconfig`: Follow `.editorconfig`:
- Python: 4-space indent - Python: 4-space indent