Skip to content
The conventional commits specification
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archetypes feat: Bump up beta version to 1.0.0-beta.3 Jan 29, 2019
content feat(it): Add beta.4 Jul 13, 2019
data style: Move to new UI Sep 16, 2018
layouts style: Move to new UI Sep 16, 2018
static style: Move to new UI Sep 16, 2018
themes/conventional-commits fix(security): address security vulnerability in node-sass (#158) Jun 10, 2019
.gitignore style: Move to new UI Sep 16, 2018
CODE_OF_CONDUCT.md chore: Add code of conduct (#55) May 24, 2018
CONTRIBUTING.md chore(contributing): remove duplicated word Feb 4, 2019
Dockerfile style: Move to new UI Sep 16, 2018
Dockerfile.dev style: Move to new UI Sep 16, 2018
LICENSE chore: Add MIT LICENSE (#56) May 24, 2018
Makefile style: Move to new UI Sep 16, 2018
README.md chore(readme): update config.yml to match config.yaml Feb 4, 2019
_redirects feat: release version 1.0.0-beta.4 of spec (#141) Apr 16, 2019
config.yaml feat: Enable translation on the website Jul 13, 2019
docker-compose.yml

README.md

ConventionalCommits.org

Conventional Commits

This repo is the home of the Conventional Commits specification.

Repo Layout

We use HUGO as static site generator, so we use the directory structure HUGO proposes.

Our implementation

  • ./content: contains all the versions of the specification.
  • ./content/next/: contains the version of the specification (where all the changes SHOULD be made).
  • ./content/**/index[.lang].md: contains the content of the specification, if a language is specified it's a translation.

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

  1. Create a new file in ./content/version/index.{lang}.md using the hugo command hugo new {version}/index.{lang}.md.
  2. Ensure all files have the appropriate fields required (see others as an example)..
  3. Add the language to the config.yaml file (see others as an example).

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.

Once the website will be compiled, you can see the website visiting http://localhost:1313

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

To Lorenzo D'Ianni for the great effort creating the CSS and the HTML for the new UI.

To Netlify to host our project, giving us a lot of amazing built in functionality for free.

To semver.org: we used semver.org as a blueprint for the structure of this specification and the first version of the website.

You can’t perform that action at this time.