Conventional Commits

Conventional commits make it very easy to share the progress with stakeholders. You can give them a query to see only commits adding features or fixing bugs.

An example is the filtered GitHub commit log for my Aircraft Noise project.

Specifications

• netlify: Conventional Commits v1.0.0-beta.4

• GitHub: angular / angular / CONTRIBUTING.md - The section Type shows the commit types and their description.

• conventional-commit-types-cli - CLI to list conventional commit types.

   npm install -g conventional-commit-types-cli
   ...
   conventional-commit-types
  

Tools and Helpers

• GitHub: Semantic Pull Requests - GitHub status check that ensures your pull requests follow the Conventional Commits spec.

• GitHub: Conventional Changelog - Generate a CHANGELOG from git metadata.

• commitlint - npm package helping your team adhering to a commit convention.

• GitHub: Commitizen for contributors - Prompt to fill out any required commit fields at commit time.

• GitHub: cz-conventional-changelog - Prompt for conventional changelog standard.

• GitHub: conventional-commit-types - List of conventional commit types.

Git Trailer Format

• git Reference: git-interpret-trailers