3229cf412f
Bumps [yaml](https://github.com/eemeli/yaml) to 2.2.2 and updates ancestor dependency [cssnano](https://github.com/cssnano/cssnano). These dependencies need to be updated together. Updates `yaml` from 2.1.3 to 2.2.2 - [Release notes](https://github.com/eemeli/yaml/releases) - [Commits](https://github.com/eemeli/yaml/compare/v2.1.3...v2.2.2) Updates `cssnano` from 5.1.13 to 6.0.0 - [Release notes](https://github.com/cssnano/cssnano/releases) - [Commits](https://github.com/cssnano/cssnano/compare/cssnano@5.1.13...cssnano@6.0.0) --- updated-dependencies: - dependency-name: yaml dependency-type: indirect - dependency-name: cssnano dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> |
||
---|---|---|
.idea | ||
archetypes | ||
content | ||
data | ||
layouts | ||
static | ||
themes/conventional-commits | ||
_redirects | ||
.gitignore | ||
.node-version | ||
CODE_OF_CONDUCT.md | ||
config.yaml | ||
CONTRIBUTING.md | ||
docker-compose.yml | ||
Dockerfile | ||
Dockerfile.dev | ||
LICENSE | ||
Makefile | ||
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.