xsteadfastx/conventionalcommits.org
1
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2024-11-15 02:45:15 +01:00
Code Issues Projects Releases Wiki Activity
59 Commits 9 Branches 0 Tags 4.8 MiB
SCSS 56%
HTML 35.5%
JavaScript 4.3%
Makefile 2.5%
Dockerfile 1.7%
a221860d45
Go to file
Volodymyr Bilokur a221860d45 Add Monica to the list of projects 
This is not my project but I learned about Conventional Commits because I decided to contribute back to Monica, so I believe it deserves to be in the list for spreading the word about your great initiative. And of course, the project is cool, too! :)
2019-01-22 12:21:00 +01:00
archetypes style: Move to new UI 2018-09-16 23:40:02 +02:00
content Add Monica to the list of projects 2019-01-22 12:21:00 +01:00
data style: Move to new UI 2018-09-16 23:40:02 +02:00
layouts style: Move to new UI 2018-09-16 23:40:02 +02:00
static style: Move to new UI 2018-09-16 23:40:02 +02:00
themes/conventional-commits style: Welcome page tweaks for long texts. Removing Prettier unnecessary changes 2018-10-26 12:41:28 +02:00
_redirects style: Move to new UI 2018-09-16 23:40:02 +02:00
.gitignore style: Move to new UI 2018-09-16 23:40:02 +02:00
CODE_OF_CONDUCT.md chore: Add code of conduct (#55) 2018-05-24 10:55:55 -07:00
config.yaml feat: Adding French translation 2018-11-19 18:29:43 +01:00
CONTRIBUTING.md chore: Add CONTRIBUTING guideline 2018-05-29 19:53:07 +02:00
docker-compose.yml style: Move to new UI 2018-09-16 23:40:02 +02:00
Dockerfile style: Move to new UI 2018-09-16 23:40:02 +02:00
Dockerfile.dev style: Move to new UI 2018-09-16 23:40:02 +02:00
LICENSE chore: Add MIT LICENSE (#56) 2018-05-24 10:55:26 -07:00
Makefile style: Move to new UI 2018-09-16 23:40:02 +02:00
README.md chore: Fix link to Lorenzo's profile 2018-09-16 23:43:09 +02:00

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.yml 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.