Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/conventional-commits/conventionalcommits.org
The conventional commits specification
https://github.com/conventional-commits/conventionalcommits.org
commit convention conventional-changelog conventional-commits git specification standard
Last synced: 21 days ago
JSON representation
The conventional commits specification
- Host: GitHub
- URL: https://github.com/conventional-commits/conventionalcommits.org
- Owner: conventional-commits
- License: mit
- Created: 2016-04-05T04:27:20.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T05:22:14.000Z (3 months ago)
- Last Synced: 2024-10-01T21:22:18.219Z (about 1 month ago)
- Topics: commit, convention, conventional-changelog, conventional-commits, git, specification, standard
- Language: SCSS
- Homepage: https://conventionalcommits.org
- Size: 1.3 MB
- Stars: 6,996
- Watchers: 77
- Forks: 537
- Open Issues: 127
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ccamel - conventional-commits/conventionalcommits.org - The conventional commits specification (SCSS)
- awesome-translation - Conventional Commits
- awesome-repositories - conventional-commits/conventionalcommits.org - The conventional commits specification (SCSS)
- awesome-github-star - conventionalcommits.org - commits | 5754 | (SCSS)
- stars - conventional-commits/conventionalcommits.org - The conventional commits specification (SCSS)
- awesome-list - conventionalcommits.org - commits | 3174 | (SCSS)
- awesome - conventional-commits/conventionalcommits.org - The conventional commits specification (SCSS)
- my-awesome - conventional-commits/conventionalcommits.org - changelog,conventional-commits,git,specification,standard pushed_at:2024-10 star:7.0k fork:0.5k The conventional commits specification (SCSS)
- jimsghstars - conventional-commits/conventionalcommits.org - The conventional commits specification (SCSS)
README
# ConventionalCommits.org
[](https://conventionalcommits.org)
This repo is the home of the Conventional Commits specification.
## Repo Layout
We use [HUGO](https://gohugo.io/) as static site generator, so we use the [directory structure](https://gohugo.io/getting-started/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`.
1. Ensure all files have the appropriate fields required (see others as an example)..
1. 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](https://docs.docker.com/compose/install/#install-compose) 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:
```markdown
[](https://conventionalcommits.org)
```
## Thank you
To **[Lorenzo D'Ianni](https://github.com/lorenzodianni)** for the great effort creating the CSS and the HTML for the new UI.
To **[Netlify](https://www.netlify.com/)** to host our project, giving us a lot of [amazing built in functionality](https://www.netlify.com/features/) for free.
To **[semver.org](https://github.com/mojombo/semver.org)**: we used [semver.org](https://github.com/mojombo/semver.org) as a blueprint for
the structure of this specification and the first version of the website.