ConventionalCommits.org

This repo is the home of the Conventional Commits specification.

Repo Layout

./index.md: contains the current version of the specification.
./spec: contains past versions of the specification.
./lang: contains various translations of the specification.

Contributing

We'd love your help refining the language of this specification, fixing typos, or adding more translations. Please don't hesitate to send a pull request.

Adding a translation

Create a new folder in lang/ with the appropriate language tag.
Add a translated index.md to that folder.
Add a translated spec/vX.X.X.md for the latest spec to that folder.
Ensure all files have the appropriate title and language front matter (see others as an example).
Add the language to the _config.yml file.

Running project locally

There's a docker-compose.yml file ready that will help you to check if the website looks good! To run it make sure you have docker-compose installed on your machine and just use the command docker-compose up to make it run locally.

Badges!

Tell your users that you use the Conventional Commits specification:

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

Thank you semver.org

We used semver.org as a blueprint for both the website and structure of this specification.

1.6 KiB Raw Blame History