From 549fdd8171a20b1d35a1ea32d9da8b899d19200f Mon Sep 17 00:00:00 2001 From: s1d3sw1ped_bot Date: Tue, 1 Sep 2026 18:54:34 +0000 Subject: [PATCH] docs: Add CONTRIBUTING.md Point new contributors at develop for PRs, kernel-style commit subjects, What/Why/Test PR bodies, and safe issue citations under Gitea merge-text closing rules. --- CONTRIBUTING.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ca38dc7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,40 @@ +# Contributing + +## Propose changes + +Open a pull request against `develop`. Keep the default branch for releases and +stable tips; land work on `develop` first. + +Point at an existing issue when one fits. Prefer a short issue that states the +symptom or request before a large PR. + +## Commits + +Subject form: + +``` +area: Imperative summary +``` + +- **Area** is a real package, directory, or subsystem token (`ci:`, `docs:`, + Go package name). Not a lone filename. +- **Imperative** mood: Fix, Add, Remove — not "Fixed" or "This patch…". +- No trailing period. Aim ≤ ~70–75 characters for the whole subject. +- Not conventional-commits (`feat:` / `fix:` / `chore:` as types). + +Body explains **why**. Establish the problem, then say what you are doing. +One logical change per commit; split fix and cleanup. + +## Pull requests + +Title matches the primary commit subject. + +- **What** changed +- **Why** (problem and impact) +- **Test** (concrete steps; "CI green" alone is weak) + +## Issues and closing + +Cite leftover issues by **full URL**. Gitea closes issues when `#N` appears in +merge text, so do not put `#N` in the merge message unless that issue is actually +done. Use `Fixes #N` / `Closes #N` only when the leftover work is finished.