From 4d7f770fd6e644ae69e52deea102c94bda40deb8 Mon Sep 17 00:00:00 2001 From: Willem Jiang <143703838+willem-bd@users.noreply.github.com> Date: Fri, 13 Nov 2026 07:26:09 +0800 Subject: [PATCH] docs(contributing): leave changelog updates to merge time (#8202) Contributor PRs that touch CHANGELOG.md collide with the fast-moving Unreleased section on main, and reviewers have been asking submitters to drop the hunk case by case (e.g. #8183). State the rule in the Development Workflow: maintainers add the entry at merge time, keeping the Unreleased section's structure and ordering consistent and the English and Chinese files in sync. Co-authored-by: Willem Jiang Co-authored-by: Claude Code --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9ba099a38..d82a34225c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -320,6 +320,14 @@ Nginx (port 2026) ← Unified entry point git push origin feature/your-feature-name ``` +Please don't include changes to `CHANGELOG.md` or `CHANGELOG_zh.md` in your +pull request. Maintainers add the changelog entry at merge time: this keeps +the Unreleased section's structure and entry ordering consistent and its +English and Chinese files in sync, and it avoids conflicts with other +in-flight merges, where the Unreleased section changes frequently. If your +PR touches the changelog, a reviewer will ask you to drop that hunk — the +rest of the PR is unaffected. + ## AI assistance disclosure DeerFlow is an AI project and we welcome AI-assisted contributions. To help