git message format
Format
Header (required)
Body (optional)
Footer (optional)
Header
Header should contain type(required), scope(optional) and subject(required) in one line.
1. type
type is used to describe the type of a commit. Several commonly used types are provided for consideration:
2. scope
scope describes the scope of a commit, such as view layer, data layer, etc.
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
Body
Body contains more detailed explanatory text where contents could be wapped to multiple lines.
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
Appendix
Below is some commits from Lark/pc-client repository:
Reference
Last updated
Was this helpful?