From 07285ddd6ddead88700a539a1a9ca4b0656efda3 Mon Sep 17 00:00:00 2001 From: s1d3sw1ped_bot Date: Tue, 1 Sep 2026 18:51:08 +0000 Subject: [PATCH 1/3] 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 | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9560597 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. From cf6dd2c310deae2e655d372f6b1f2f20290c7e3c Mon Sep 17 00:00:00 2001 From: s1d3sw1ped_bot Date: Tue, 1 Sep 2026 19:00:20 +0000 Subject: [PATCH 2/3] docs: Align CONTRIBUTING.md with develop main and develop carried different CONTRIBUTING.md blobs after parallel docs landings. Replace the main copy with the develop tip content so both branches share one guide. --- CONTRIBUTING.md | 36 ------------------------------------ 1 file changed, 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9560597..e69de29 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +0,0 @@ -# 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. From 96874da7aa14d9735d1519374d9cf60f9e4192fc Mon Sep 17 00:00:00 2001 From: s1d3sw1ped_bot Date: Tue, 1 Sep 2026 19:08:03 +0000 Subject: [PATCH 3/3] docs: Restore develop CONTRIBUTING.md content Prior commit on this branch emptied the file after a bad fetch. Write the develop tip blob so main matches develop. --- CONTRIBUTING.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29..fed3ca7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,44 @@ +# 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. + +## License + +License TBD by owner.