5290a99fa5 | 4 weeks ago | |
---|---|---|
.idea | 4 years ago | |
archetypes | 3 years ago | |
content | 4 weeks ago | |
data | 6 years ago | |
layouts | 6 years ago | |
static | 2 years ago | |
themes/conventional-commits | 2 years ago | |
.gitignore | 2 years ago | |
.node-version | 2 years ago | |
CODE_OF_CONDUCT.md | 6 years ago | |
CONTRIBUTING.md | 5 years ago | |
Dockerfile | 2 years ago | |
Dockerfile.dev | 2 years ago | |
LICENSE | 6 years ago | |
Makefile | 2 years ago | |
README.md | 2 years ago | |
_redirects | 5 years ago | |
config.yaml | 4 months ago | |
docker-compose.yml | 6 years ago |
README.md
ConventionalCommits.org
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
- Create a new file in
./content/version/index.[lang].md
using the hugo commandhugo new [version]/index.[lang].md
. - Ensure all files have the appropriate fields required (see others as an example)..
- 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-%23FE5196?logo=conventionalcommits&logoColor=white)](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.