Changelog
The canonical changelog is the repository root file:
CHANGELOG.md at the repository root (also shown on GitHub’s Releases when you tag).
It follows Keep a Changelog and Semantic Versioning.
Current version
See the root VERSION file and package.json "version" field (they should match).
Release process (maintainers)
Every user-visible land on master is a versioned release (patch, minor, or major).
- Update
CHANGELOG.md: move[Unreleased]notes into a new## [X.Y.Z] — YYYY-MM-DDsection. - Set the same version in
VERSION,package.json, and the README “currently” line. - Commit on
master:Release vX.Y.Z: …. - Tag:
git tag -a vX.Y.Z -m "vX.Y.Z". - Push branch and tags:
git push origin master --tags. - Optionally create a GitHub Release from the tag.
Do not rewrite published changelog sections except for obvious typos. Do not push curriculum changes to master without a version + changelog bump.