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
38 Commits 9 Branches 0 Tags 4.8 MiB
SCSS 56%
HTML 35.5%
JavaScript 4.3%
Makefile 2.5%
Dockerfile 1.7%
1209ce71d3
Go to file
Zeke Sikelianos 1209ce71d3 docs: add Electron to list of projects 
The @electron project is now using Conventional Commits in many of its repos. We also built a bot to help make sure every PR we ship follows the CC spec: https://github.com/probot/semantic-pull-requests

We also use `semantic-release` all over the place: https://github.com/search?utf8=%E2%9C%93&q=%22npm+run+semantic-release%22+%40electron&type=Code
2018-07-26 11:07:28 +02:00
_layouts feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
css feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
js spelling: elements (#36) 2018-03-07 09:27:26 +11:00
lang fix: updates all references to the Angular commit guidelines 2018-05-31 22:51:49 +02:00
script feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
spec fix: updates all references to the Angular commit guidelines 2018-05-31 22:51:49 +02:00
_config_local.yml feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
_config.yml feat(lang): v1.0.0-beta.2 spanish translation 2018-05-24 11:59:25 -04:00
.gitignore feat: Update dependencies and add docker-compose for easier development 2018-05-11 22:21:29 +02:00
CNAME feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
CODE_OF_CONDUCT.md chore: Add code of conduct (#55) 2018-05-24 10:55:55 -07:00
config.ru feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
CONTRIBUTING.md chore: Add CONTRIBUTING guideline 2018-05-29 19:53:07 +02:00
docker-compose.yml feat: Update dependencies and add docker-compose for easier development 2018-05-11 22:21:29 +02:00
Gemfile feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
Gemfile.lock feat: Update dependencies and add docker-compose for easier development 2018-05-11 22:21:29 +02:00
index.md docs: add Electron to list of projects 2018-07-26 11:07:28 +02:00
LICENSE chore: Add MIT LICENSE (#56) 2018-05-24 10:55:26 -07:00
Procfile feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
Rakefile feat: use semver.org as a basis for conventionalcommits.org (#2) 2017-04-08 11:57:18 -07:00
README.md docs: Add docker-compose documentation 2018-07-04 21:05:04 +02:00

README.md

ConventionalCommits.org

Conventional Commits

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

  1. Create a new folder in lang/ with the appropriate language tag.
  2. Add a translated index.md to that folder.
  3. Add a translated spec/vX.X.X.md for the latest spec to that folder.
  4. Ensure all files have the appropriate title and language front matter (see others as an example).
  5. 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.