Skip to content

docs: add calver changeset rules to AGENTS.md #4637

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
vctrchu merged 4 commits into from
Aug 20, 2026
Merged

docs: add calver changeset rules to AGENTS.md #4637

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9aa9da2
docs: add calver changeset rules to AGENTS.md
vctrchu Aug 17, 2026
063f365
style: prettier AGENTS.md
vctrchu Aug 18, 2026
1aa323e
docs: drop incident citation
vctrchu Aug 18, 2026
70aab6c
Merge branch '2026-10-rc' into vchu/agents-calver-docs
vctrchu Aug 20, 2026
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
17 changes: 17 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,23 @@ After every change, you must:
3. **Check for type errors** — run the TypeScript compiler to verify there are no type errors.
4. **Check for lint and formatting errors** — run the linter and formatter to ensure code quality.

## Changesets and versioning

Package versions are **calendar versions**: the `major.minor` of the npm
version _is_ the Shopify API version (`2026.10.x` → API version `2026-10`,
derived at build time — see `packages/ui-extensions-tester/src/api-version.ts`).

- **Never mark a changeset `major`.** A major bump rolls the calendar year
(`2026.10.0` → `2027.0.0` → API version "2027-00", which doesn't exist),
breaks the tester's version check on every PR, and publishes an RC that is
Comment thread
vctrchu marked this conversation as resolved.
semver-higher than the branch's own final release. Breaking changes are
already gated by API version; declare them `minor` and describe the break in
the changeset text.
- On RC branches (`.changeset/pre.json` present), released changeset files are
**retained** and keep contributing to version computation until pre-mode
exits — correcting a bad version requires fixing the changeset file itself,
not just `package.json`.

## ui-extensions-tester

When working on `ui-extensions-tester`, ALWAYS read [packages/ui-extensions-tester/AGENTS.md](packages/ui-extensions-tester/AGENTS.md).
Loading