xsteadfastx/conventionalcommits.org
1
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2024-11-15 10:55:16 +01:00
Code Issues Projects Releases Wiki Activity
191 Commits 9 Branches 0 Tags 4.8 MiB
SCSS 56%
HTML 35.5%
JavaScript 4.3%
Makefile 2.5%
Dockerfile 1.7%
974953e6dd
Go to file
Juri Burakov 974953e6dd
Create xanitizer-analysis.yml
2020-12-02 21:14:43 +02:00
.github Create xanitizer-analysis.yml 2020-12-02 21:14:43 +02:00
.idea fix: make v.1.0.0 public again on the website 2020-04-20 17:23:17 +02:00
archetypes fix: make v.1.0.0 public again on the website 2020-04-20 17:23:17 +02:00
content docs: adding Conventional Commits Next Version 2020-09-20 17:12:31 +02: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 build(deps): bump elliptic in /themes/conventional-commits 2020-08-09 19:33:50 +02:00
_config.yml Set theme jekyll-theme-merlot 2020-12-02 20:32:05 +02:00
_redirects feat: release 1.0.0 of specification (#175) 2019-09-30 00:11:17 -04: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(lang): add Thai translation 2020-08-10 11:56:34 +02:00
CONTRIBUTING.md chore(contributing): remove duplicated word 2019-02-04 15:30:50 +01:00
docker-compose.yml style: Move to new UI 2018-09-16 23:40:02 +02:00
Dockerfile fix(deps) add missing dependencies in Dockerfile (#293) 2020-08-27 20:57:43 -07: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(readme): update config.yml to match config.yaml 2019-02-04 15:28:09 +01:00
SECURITY.md Create SECURITY.md 2020-09-30 03:03:59 +03: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.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.