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 endpointgit log --oneline --grep '^feat'Related terms
- commit type — The word at the start of a Conventional Commits subject that says what kind of change the commit is, such as feat or fix.
- breaking change — A change that makes existing users of a program or interface stop working until they change something too.
- semantic versioning — A version numbering scheme of three numbers, major.minor.patch, raised for breaking changes, new features and fixes respectively.
- commit message — The text a person writes into a commit to say what it does and why: a one-line subject, a blank line, then an optional body.
Taught in
- Committing, And What A Good Message Says — Advanced Git Internals & Distributed Workflows
- Conventional Commits — Advanced Git Internals & Distributed Workflows