starred/herdr
1
0
Fork 0
mirror of https://github.com/herdrdev/herdr.git synced 2026-09-21 16:01:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: document issue reference commits

Browse Source
This commit is contained in:
Ogulcan Celik
2026-05-16 23:52:25 +03:00
parent 311a1cf9fa
commit 1342a76e60
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+14
View File
@@ -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.