https://github.com/commitizen/conventional-commit-types

List of conventional commit types.
https://github.com/commitizen/conventional-commit-types

Last synced: 7 days ago
JSON representation

List of conventional commit types.

• Host: GitHub
• URL: https://github.com/commitizen/conventional-commit-types
• Owner: commitizen
• Created: 2016-08-07T03:58:10.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-05T01:07:56.000Z (over 3 years ago)
• Last Synced: 2024-04-13T22:53:38.378Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 437
• Watchers: 12
• Forks: 75
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# conventional-commit-types

[![npm](https://img.shields.io/npm/v/conventional-commit-types.svg?maxAge=2592000)](https://www.npmjs.com/package/conventional-commit-types)

[![Build Status](https://img.shields.io/travis/commitizen/conventional-commit-types.svg?maxAge=2592000)](https://travis-ci.org/commitizen/conventional-commit-types)

List of conventional commit types.

## Spec

Exports an object with a `types` key whose value is an object whose keys are type names and whose values are objects with key-value pairs such as `description` as string, optional `title` as string, etc. See [index.json](index.json). Any alternatives should follow the same spec.

## Etc.

Used by [commitizen/cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog) for [commitizen/cz-cli](https://github.com/commitizen/cz-cli).

Can be used with [kentcdodds/validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg#types).

Commit types originally from:

* [Angular Git Commit Message Conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type)

* [commitizen/cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)

Created for [AndersDJohnson/conventional-commit-types-cli](https://github.com/AndersDJohnson/conventional-commit-types-cli).