Skip to content

docs: require confirmation for release notes changes #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JJasonSun merged 1 commit into from
Sep 28, 2026
Merged

docs: require confirmation for release notes changes #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Loading