937 B
937 B
Instructions for this repository
CHANGELOG.md
CHANGELOG.mdrecords the changes of each version, newest entry first.release.mjsreads it to commit, tag and push.- An entry is a
## x.y.zheading, a blank line, one summary line, a blank line, and the changes as-items. - The summary line is the commit message: a type prefix as in the git history (
feature:,fix:,update:), then one sentence. It must not start with-or#. - An entry whose version is already tagged (
git tag) is released and must not be changed. Changes after it go into a new entry above it. - Record every change you make in the newest untagged entry; when there is none, add one. Raise the patch version for fixes and the minor version for features.
- Items describe what changed for the user, not the reasoning; reasons go to
ADR.md. - Do not run
release.mjswithout-n; committing, tagging and pushing need the user's approval.