diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-16 23:52:15 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-05-16 23:52:25 +0300 |
| commit | 1342a76e60ff46c45dcceee689f6eed180eb0650 (patch) | |
| tree | d77779307cef6011dbe4e21cc81f3f1a50e2a364 | |
| parent | 311a1cf9fad942cebebaf155f40b92460025a1c5 (diff) | |
docs: document issue reference commits
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45aeae8b..31f0ba02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,6 +83,20 @@ just ci Do not open a PR that bypasses failing tests, formatting, or build errors. +## Issue references in commits + +If your PR relates to a GitHub issue, reference it in the commit body with `refs #<issue-number>`. + +Example: + +```text +fix: handle pane focus + +refs #128 +``` + +Do not use GitHub closing keywords like `fixes #128`, `closes #128`, or `resolves #128` in normal PR commits. Herdr closes released issues after a release is published, not when unreleased commits land on `master`. + ## PR scope Small bug fixes that clearly match the existing design are good candidates for PRs after approval. |