conventionalcommits.org

This repository is the home of the Conventional Commits specification, published at conventionalcommits.org. The README badge indicates the current specification version is 1.0.0. The specification defines a convention for writing Git commit messages in a standardized, machine-readable structure, and the project credits semver.org as the blueprint for both the specification's structure and the first version of the website. Website and repository layout: The site is built with the Hugo static site generator and follows Hugo's standard directory structure. The ./content directory contains all published versions of the specification, ./content/next/ holds the in-development version where changes should be made, and files named index.[lang].md contain the specification content, with a language code indicating a translation. Contributing: The project welcomes pull requests that refine the specification's wording, fix typos, or add new translations. To add a translation, contributors create a new file using the hugo new [version]/index.[lang].md command, ensure the required front-matter fields are present (using existing files as examples), and register the new language in config.yaml. Local development: A docker-compose.yml file is included so contributors can preview the site locally. With docker-compose installed, running docker-compose up compiles the site, which is then viewable at http://localhost:1313. Badges: Projects that follow the Conventional Commits specification can display a Conventional Commits badge using the Markdown snippet provided in the README. Credits: The README thanks Lorenzo D'Ianni for creating the CSS and HTML for the new UI, and Netlify for hosting the project with built-in functionality provided free of charge.