search

git message format

hashtag
Format

  • Header (required)

  • Body (optional)

  • Footer (optional)

<type>(<scope>): <subject>
\n
<body>
\n
<footer>

hashtag
Header

Header should contain type(required), scope(optional) and subject(required) in one line.

hashtag
1. type

type is used to describe the type of a commit. Several commonly used types are provided for consideration:

- feat: new feature
- fix: fix bug
- refactor: modifications other than features or fixes
- release: release a new version
- style: format or beautify code without effects on main function
- chore: modifications of dependencies or build tools
- docs: write documentation(e.g. README.md)

hashtag
2. scope

scope describes the scope of a commit, such as view layer, data layer, etc.

hashtag
3. subject

subject is a brief description of a commit and it's suggested to be limited in 50 characters.

  • start with a verb

  • end without a period

hashtag
Body

Body contains more detailed explanatory text where contents could be wapped to multiple lines.

hashtag
Footer

Footer is an uncommon part. When some breaking changes are added to a commit, it's mainly used to append descriptions, reasons and methods of migration

hashtag
Appendix

Below is some commits from Lark/pc-client repository:

hashtag
Reference

PreviousVersion ControlNextgit commands

Last updated