From 1d37b265d93dc0ef7e1d446a474ef51cea2b2de1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Enrique=20Lo=CC=81pez=20Man=CC=83as?= Date: Thu, 1 Oct 2026 19:04:35 +0200 Subject: [PATCH] docs: explain BEGIN_COMMIT_OVERRIDE for PRs with several changes A squash merge keeps only the PR title, so release-please lists one changelog entry per PR. Document the commit override block for PRs that contain several changes that should be listed separately. --- AGENTS.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 4a58c7c10..80c542b2d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -102,6 +102,21 @@ template). Never hardcode or commit API keys. - Use Conventional Commit messages (`feat:`, `fix:`, `docs:`, ...). release-please parses them to generate versions and CHANGELOG.md; a wrong prefix causes a wrong release bump. Never edit CHANGELOG.md by hand. +- **Several changes in one PR**: a squash merge keeps only the PR title, so + release-please would list one entry. When a PR contains several changes that + belong in the changelog separately (for example several bug fixes), add a + commit override block at the end of the PR description, one Conventional + Commit per line. release-please uses these lines instead of the PR title: + + ``` + BEGIN_COMMIT_OVERRIDE + fix(clustering): describe the first fix + fix(widgets): describe the second fix + END_COMMIT_OVERRIDE + ``` + + The PR title still has to be a valid Conventional Commit. Each line counts + for the version bump, so a `feat:` or `!` line bumps accordingly. - Every behavior change needs a unit test in the affected module. - All pull requests are to be created as drafts (`gh pr create --draft`) until authorization is explicitly given to mark them ready for review. Always inform the user that the PR was created as a draft. - Run the module's tests and `lint` before declaring work done, and report