Skip to content

Commit 7162c35

Browse files
committed
docs: update release process documentation for contributors and maintainers
1 parent 718a899 commit 7162c35

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,3 +130,13 @@ yarn seed # seed demo data
130130
yarn lint # ESLint
131131
npx skills add <src> -a claude-code -a codex --copy # install skills
132132
```
133+
134+
---
135+
136+
## Release
137+
138+
Releases use [Changesets](https://github.com/changesets/changesets).
139+
140+
- For any user-facing change, add a changeset: `yarn changeset` (or create a `.changeset/*.md` file with the bump level and summary).
141+
- **The maintainer runs the release flow**`yarn prepare-release` (runs `changeset version`, commits the bump, pushes `develop`, creates the `release/vX.Y.Z` branch, and opens the release PR).
142+
- Agents must **not** run `prepare-release` or `git push` to remote. Prepare locally only — create the changeset and commits — then hand off with the exact command (`yarn prepare-release`). Push/publish only if the maintainer explicitly asks this time.

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ This guide explains how we organize releases, structure branches, and prepare pu
1010

1111
## Working on Features
1212

13+
> **External contributors:** your flow ends at a PR to `develop` — branch from `develop`, add a changeset, open the PR. You do **not** create releases; maintainers handle the [Release Process](#release-process) below.
14+
1315
1. **Branch from `develop`**:
1416
```bash
1517
git checkout develop
@@ -34,6 +36,8 @@ This guide explains how we organize releases, structure branches, and prepare pu
3436

3537
## Release Process
3638

39+
> **Maintainers only.** Steps 1–3 are automated by `yarn prepare-release` (runs `changeset version`, commits, pushes `develop`, creates the `release/vX.Y.Z` branch, and opens the release PR). The steps below document what the script does.
40+
3741
### Normal Release Flow
3842

3943
1. **Prepare release on `develop`**:

0 commit comments

Comments
 (0)