conventionalcommits.org
The conventional commits specification
The website and specification for Conventional Commits, a standard format for git commit messages that makes project history readable by both humans and automated tools.
This repository is the home of the Conventional Commits specification, a naming convention for git commit messages. The specification defines a standard format for writing commit messages so that tools and humans can read a project's history in a consistent, structured way. The website at conventionalcommits.org is built and maintained from this repo.
The site is generated using HUGO, a static site builder. The specification content lives in the content folder, and new versions or edits are made there. The repo also supports translations: if you want to add the specification in a new language, you create a new file following a naming pattern and add the language to the site configuration.
Contributors are welcome to fix typos, improve wording, or add translations. The process is a standard pull request workflow. To preview the site locally before submitting changes, the repo includes a Docker Compose file that spins up the site at a local address.
The repo also provides a badge that project maintainers can paste into their own README files to signal that their project follows the Conventional Commits standard. Beyond the specification content and site infrastructure, this repository does not contain application logic or libraries.
Where it fits
- Add the Conventional Commits badge to your README to signal that your project follows the commit message standard.
- Contribute a translation of the specification to a new language by adding a localized content file to the repo.
- Preview the conventionalcommits.org site locally using Docker before submitting a typo fix or wording improvement.