Skip to content

docs: require a changelog section with every version bump #46

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
smiggleworth merged 1 commit into from
Sep 29, 2026
Merged

docs: require a changelog section with every version bump #46

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
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ demonstrated transport need.
Run `npm run check` and the relevant HTTP benchmark before declaring a
performance-sensitive change ready.

## Changelog

Any change to the `version` field in `package.json`, whether a release,
prerelease, or patch bump, must include a matching `## <version>` section in
`CHANGELOG.md` in the same commit or pull request. Date the section and list
breaking changes (with migration notes), deprecations, additions, and fixes.
Move entries from `Unreleased` into the new version section rather than leaving
them there. If the repository has no `CHANGELOG.md` yet, create one (Keep a
Changelog style) at the next version bump. Do not publish or tag a version whose
changelog section is missing.

## Optimization Gate

A benchmark number is only half of an optimization's success criterion. The
Expand Down
Loading