Template Changelog
Workflow
- Determine whether the change modifies the template (code, config, docs, deps). If yes, add a changelog entry.
- Decide the commit subject (the single commit you will create for the change).
- Record the previous commit hash (short):
git rev-parse --short HEAD. - Add a new entry at the top of
## EntriesinCHANGELOG.mdusing the template inreferences/changelog-format.md. - Commit everything (template changes +
CHANGELOG.md) in a single commit using the subject from step 2. - Keep entries in reverse chronological order and avoid editing older entries except for corrections.
Notes
- The pre-push hook blocks pushes that do not include a
CHANGELOG.mdchange.
Resources
references/changelog-format.md