From ecd7620d1229f7376ed0fee480a0f64fdb6aa771 Mon Sep 17 00:00:00 2001 From: "J.Jason" <130959319+JJasonSun@users.noreply.github.com> Date: Mon, 28 Sep 2026 14:26:40 +0800 Subject: [PATCH] docs: require confirmation for release notes changes --- AGENTS.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index c0bfb70..ca89293 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -15,7 +15,7 @@ When maintainers provide a backend API change: 1. Read the approved backend specification, OpenAPI diff, and rollout status. 2. Update `openapi/calle.openapi.yaml`, affected MDX guides, examples, - changelog, and observable tests. + and observable tests. 3. Run `pnpm run validate`. 4. Open a focused pull request that links the backend change and lists the affected public API surface. @@ -25,6 +25,12 @@ When maintainers provide a backend API change: The public docs must not describe a new capability before that capability is available in the public API. +Routine documentation maintenance and API documentation sync must not +automatically add changelog (release notes) entries. Before adding an entry or +substantively modifying an existing one, present the proposed content and obtain +explicit confirmation from the user or a maintainer. Continue other documentation +work while awaiting confirmation. + ## Security - Never add API keys, OSS credentials, private URLs, customer data, phone