explaingit

conventional-commits/conventionalcommits.org

★ 8,841SCSSAudience · developerComplexity · 1/5Setup · easy

TLDR

The website and specification for Conventional Commits, a standard format for git commit messages that makes project history readable by both humans and automated tools.

Mindmap

mindmap
  root((conventionalcommits))
    What it does
      Define commit format
      Enable tool parsing
      Readable history
    Site tech
      Hugo
      SCSS
      Docker Compose
    Contributing
      Fix typos
      Add translations
      Pull requests
    Audience
      Developers
      Open source maintainers
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Add the Conventional Commits badge to your README to signal that your project follows the commit message standard.

USE CASE 2

Contribute a translation of the specification to a new language by adding a localized content file to the repo.

USE CASE 3

Preview the conventionalcommits.org site locally using Docker before submitting a typo fix or wording improvement.

Tech stack

SCSSHugoDocker

Getting it running

Difficulty · easy Time to first run · 5min

This is a documentation specification site, run Docker Compose to preview locally before contributing.

In plain English

This repository is the home of the Conventional Commits specification, a naming convention for git commit messages. The specification defines a standard format for writing commit messages so that tools and humans can read a project's history in a consistent, structured way. The website at conventionalcommits.org is built and maintained from this repo. The site is generated using HUGO, a static site builder. The specification content lives in the content folder, and new versions or edits are made there. The repo also supports translations: if you want to add the specification in a new language, you create a new file following a naming pattern and add the language to the site configuration. Contributors are welcome to fix typos, improve wording, or add translations. The process is a standard pull request workflow. To preview the site locally before submitting changes, the repo includes a Docker Compose file that spins up the site at a local address. The repo also provides a badge that project maintainers can paste into their own README files to signal that their project follows the Conventional Commits standard. Beyond the specification content and site infrastructure, this repository does not contain application logic or libraries.

Copy-paste prompts

Prompt 1
Show me the Conventional Commits format so I can start writing structured commit messages that automated changelog tools can parse.
Prompt 2
Help me set up a git commit message template following the Conventional Commits spec for a Node.js project.
Prompt 3
Write a commit message in Conventional Commits format for adding a dark mode toggle to a web application.
Prompt 4
How do I configure commitlint to enforce the Conventional Commits specification on every commit in my repository?
Open on GitHub → Explain another repo

← conventional-commits on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.