From 94008590d0a600acf9f88c82ce8a4de06b728a48 Mon Sep 17 00:00:00 2001 From: go-while Date: Thu, 12 Nov 2026 12:01:17 +0000 Subject: [PATCH 1/2] CONTRIBUTING.md: how pull requests avoid editing the same lines NEWS entries go to changes/, REVIEW.md in batches, README only for user-visible changes, one concern per branch, tests not loosened. Co-Authored-By: Claude Opus 5.5 --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2ea8257 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to NewsCache + +Changes reach `main` only through pull requests; the required CI checks +must pass. Several pull requests are often open at once, so please keep +them from editing the same lines: + +- One concern per pull request, on a branch from `main` (for example + `fix/`). Don't collect unrelated fixes on one branch. +- Don't edit `NEWS` or `debian/changelog`. Add your NEWS entry as + `changes/.md`, with the NEWS section as its + first line (see [changes/README.md](changes/README.md)). The release + pull request moves the entries into NEWS. +- Don't edit `REVIEW.md` in a fix; it's updated in batches after merges. +- Edit `README.md` only for something users see there: a new option, + build dependency or command. +- Add a test that fails without your fix where that's practical. + Don't loosen a test's bounds or checks to make it pass on a slow + machine; find out what it really measures. +- Merge `main` into your branch (no force pushes) when it no longer + merges cleanly. + +Don't commit to `trunk`: it mirrors the old Subversion repository. From 65bfb686bdede0ed1f857bcfd538d9d5002a0ab6 Mon Sep 17 00:00:00 2001 From: go-while Date: Thu, 12 Nov 2026 13:25:42 +0000 Subject: [PATCH 2/2] CONTRIBUTING.md: the release PR edits debian/changelog; merge or rebase Found by nc-oc-gpt61t: name the release exception for debian/changelog, and don't forbid force pushes to contributor branches (.claude/CLAUDE.md says to rebase when a branch no longer merges cleanly). Co-Authored-By: Claude Opus 5.5 --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ea8257..cf4a007 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,8 @@ them from editing the same lines: - One concern per pull request, on a branch from `main` (for example `fix/`). Don't collect unrelated fixes on one branch. -- Don't edit `NEWS` or `debian/changelog`. Add your NEWS entry as +- Don't edit `NEWS` or `debian/changelog`; only the release pull + request does. Add your NEWS entry as `changes/.md`, with the NEWS section as its first line (see [changes/README.md](changes/README.md)). The release pull request moves the entries into NEWS. @@ -16,7 +17,7 @@ them from editing the same lines: - Add a test that fails without your fix where that's practical. Don't loosen a test's bounds or checks to make it pass on a slow machine; find out what it really measures. -- Merge `main` into your branch (no force pushes) when it no longer - merges cleanly. +- Bring your branch up to date with `main` (merge or rebase) when it + no longer merges cleanly. Don't commit to `trunk`: it mirrors the old Subversion repository.