docs: Add CONTRIBUTING.md

Add short contribution guide on the default branch. Prefer develop for future PRs; keep commit subjects in area: Imperative form.
2026-09-01 13:51:36 -05:00
parent 3a6f61bd43 07285ddd6d
commit 30c4763b8f
1 changed files with 36 additions and 0 deletions
@@ -0,0 +1,36 @@
+# Contributing
+
+## Pull requests
+
+Prefer pull requests against `develop`. The repository default is `master`
+or `main`; `develop` exists for ongoing integration.
+
+## Commits
+
+Subject form (kernel-style):
+
+    area: Imperative summary
+
+- Imperative mood after the colon (`Add`, `Fix`, `Remove`, …).
+- No trailing period on the subject. Aim for about 75 characters total.
+- Body states the problem and why the change is right.
+- One logical change per commit. Skip the body only when the subject alone
+  is obvious to a reviewer.
+
+## Pull request description
+
+- **What** — what changed
+- **Why** — problem and impact
+- **Test** — concrete steps a reviewer can run
+
+Do not leave the description as “see commits”.
+
+## Issues
+
+Gitea closes issues when a bare issue reference appears in merge text.
+Cite leftover issues by full URL. Only close an issue when the merge
+actually finishes that work.
+
+## License
+
+License: see LICENSE if present; otherwise TBD by owner.