- Do not manually increment the
versionfield inpackage.json. It is handled automatically. - Maintain the
CHANGELOG.mdfile as changes are made.- Do not mention changes to files outside the
src/folder or test files in the changelog. - Ensure the version heading reflects the next logical version number (e.g.,
## [1.7.2]), rather than using "Unreleased". - Do not add changes to a version that already has a release date (e.g.,
## [1.7.1] - 2026-02-22). - When adding a new version heading, do not include a release date.
- When adding to an unreleased version, check if you need to bump it (e.g., a patch version
1.0.1should be bumped to1.1.0if you are adding a new feature).
- Do not mention changes to files outside the
- Keep the
README.mdfile up-to-date after any user-facing changes (new commands, features, settings, etc.). - A GitHub workflow enforces that
CHANGELOG.mdis modified in every Pull Request.