Conventional Commits

A specification for commit subject lines of the form type(optional scope): description, so tools can read what kind of change each commit is.

In more detail

Version 1.0.0 defines two types, feat for a new feature and fix for a bug fix, and marks breaking changes with ! before the colon or a BREAKING CHANGE footer. Types such as docs, refactor, test, build, ci and chore are common convention, not part of the specification. It pays off when release notes and version numbers are generated automatically from the log.

Examples

feat(auth)!: require a token on every session endpoint
git log --oneline --grep '^feat'

Related terms

Taught in

References