Git Conventional Commit messages Cheat Sheet

A Programming › Git cheat sheet in English by Hansuld

Allows automatic change logs <type>[scope]: <description> [body] [footer]

9,298 views 1,472 downloads 25 Dec 2021 History

Set up

<ty­pe>­[sc­ope]: <de­scr­ipt­ion>

[body]

[footer]

scope

additional info
use nouns
*optional

Type

fix
Bug fix
feat
Added new feature
build
Changes that affect the build system or external depend­encies
style
Changes that do affect the meaning of code
chore
Other changes that do not modify src or test files
refactor
A code change that neither fixes a bug nor adds a feature
ci
Changes to CI config files and scripts
test
adding missing tests or correcting existing tests
docs
Docume­ntation changes
revert
Revert to previous commit

descri­ption

short message
written in the imperative - add instead of adds or added

body

free form
explain changes that you made
*optional

footer

follow the body with blank line
word token and semi colon
refere­nce­s(who helped, resolves #10)
*optional

Comments

No comments yet.

Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.