Commit Message Guideline

Jump to bottom

Andrew Elliot edited this page Aug 19, 2023 · 1 revision

This page puts some guideline to commit message so we can better cooperate.

Message are starting with a capitalized word.
- Message, ... not message, ...
Optional prefixed with keywords
- Keywords are enclosed within brackets ("[]"), and are separated with ",".
- e.g. [keyword1, keyword2, ...] Message ...

Keywords we have:

NFC : non-functional change
- It is usually used when we do a style change and renaming.
- A file renaming is also allowed but proper clarification is required in message body.