aboutsummaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-05-16 18:54:27 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-05-16 18:54:27 +0300
commit2dc50f08832058755ab42f75933e40e5d2188cb2 (patch)
treedeae6e6bd5dc9f98570aa42121c1080cab6aee67 /AGENTS.md
parentb173a86e34343a94c2941fa960b9c7e6a3bcb26a (diff)
ci: close referenced issues after release
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 3f025ac2..f5258d5f 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -57,7 +57,13 @@ Unit tests live next to the code (`#[cfg(test)] mod tests`). If you add behavior
- Before release, copy the approved `.pi/docs/` versions into the root public docs. `just release` blocks until each root public doc and `CHANGELOG.md` are identical to their `.pi/docs/` counterparts.
- Keep website copy and config examples aligned with the latest published release unless the user explicitly asks for prerelease docs.
- Put local PRDs, planning notes, and exploratory specs under `.prd/`; that directory is ignored and locally controlled.
-- When a commit fully fixes a GitHub issue, include `fixes #<issue-number>` in the commit body so GitHub closes it on merge.
+- When a normal feature or fix commit relates to a GitHub issue, add a commit body line `refs #<issue-number>` after the subject. Use this shape:
+ ```text
+ fix: handle pane focus
+
+ refs #82
+ ```
+ Do not use GitHub closing keywords like `fixes #<issue-number>`, `closes #<issue-number>`, or `resolves #<issue-number>` in normal commits, because `master` contains unreleased work and those keywords close issues before release. Release CI scans `refs #<issue-number>` body lines between release tags and closes the referenced issues after the GitHub Release is created.
- Rust: no `unwrap()` in production code. `tracing` for logging. `#[allow]` only with a comment explaining why.
- Don't bypass checks. If tests fail, fix them before committing.
- Don't add dependencies without a reason. Check if the existing deps cover it first.