-
Notifications
You must be signed in to change notification settings - Fork 0
Maintain a CHANGELOG
Alan B. Christie edited this page Feb 20, 2026
·
1 revision
A CHANGELOG file can be used to document the changes that are made to your repository as you make each new release. You won't be surprised to learn that there are a number of language-specific tools that can automate this process. When used with disciplined commit messages the tools can also automate the value for your next tag.
The cz bump tool is a powerful command that automatically determines and increases your project's version number based on your commit history. It analyses your commits to determine the appropriate version increment according to semantic versioning principles. It can also update a CHANGELOG file if required.
Policies
- Using non-xchem repositories
- Approved build tool (uv)
- Embrace pyproject.toml
- Use pre-commit
- Creating releases
- Declaring dependencies
- Merging to trunk
- Write tests
- Continuous integration
Advanced topics
Other ideas
Inspiration
Cheat-sheets