From 4d958619d567a315a0dfdb965137eb57b3e08f89 Mon Sep 17 00:00:00 2001 From: FranciscaOtero Date: Mon, 9 Nov 2026 10:49:12 -0600 Subject: [PATCH] docs(agents): document how to label releases and write release notes Co-Authored-By: Claude Opus 5.5 --- .agents/skills/add-api-resource/SKILL.md | 2 +- AGENTS.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/.agents/skills/add-api-resource/SKILL.md b/.agents/skills/add-api-resource/SKILL.md index 38a423d..b06d183 100644 --- a/.agents/skills/add-api-resource/SKILL.md +++ b/.agents/skills/add-api-resource/SKILL.md @@ -82,4 +82,4 @@ node dist/index.js [v2] --help Add or update the row in the Resources table in `README.md`, with v1 rows before v2 rows. -Follow the repository's PR template and mention the SDK bump and anything left out. Keep CLI version bumps and releases separate from resource changes. +Follow the repository's PR template and mention the SDK bump and anything left out. Do not bump the CLI version; add the release label and `## Release notes` described in `AGENTS.md`. diff --git a/AGENTS.md b/AGENTS.md index ac24a4a..7784a1a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -26,3 +26,18 @@ - Prettier runs as ESLint rule (no separate .prettierrc) - No semicolons, single quotes, printWidth 100 - `no-console: error` — use proper output utilities instead + +## Releases +Merging a PR to `main` with a `release:patch`, `release:minor` or `release:major` label +publishes a release, with notes from the PR's `## Release notes` section (see `RELEASE.md`). +Do not bump the version in feature PRs. + +Pick one label by what CLI users get: + +- `release:minor`: new commands, verbs or flags. +- `release:patch`: fixes to existing behavior, with no new public surface. +- `release:major`: removes or changes a command or flag incompatibly. `backward-compat.test.ts` blocks these, so agree on it with the team first. +- No label: changes CLI users don't get, such as tests, CI, docs or agent files. + +Write `## Release notes` in English for CLI users: one bullet per change, naming what changed +(command, verb, flag or error), without internal details.