Conventional Commits

Conventional Commits are a specification for adding human and machine readable meaning to commit messages. Using these structured commit messages, you can automate the generation of changelogs.

Example Commits

feat: allow provided config object to extend other configs
feat(api)!: send an email to the customer when a product is shipped
fix: prevent racing of requests

Using Conventional Commits with Openchangelog

Openchangelog supports creating changelog sites from Conventional Commits. To do this, you’ll need to generate a CHANGELOG.md file based on your commit messages.

We recommend using git-cliff, a tool that converts Conventional Commits into a CHANGELOG.md file, following the popular Keep a Changelog format. With your changelog file generated, you can easily use Openchangelog to turn it into a website.

Follow our Keep a Changelog guide for step-by-step instructions on setting up your changelog site with this format.