Commit messages

Commit message rules

Original article

1. Separate subject from body with a blank line
2. Limit the subject line to 72 characters
3. Capitalize the subject line
4. Do not end the subject line with a period
5. Use the imperative mood in the subject line
6. Wrap the body at 100 characters
7. Use the body to explain what and why vs. how

Example

Copied from Git official documentation (with minor changes)

Short (72 chars or less) summary of changes

More detailed explanatory text, if necessary.  Wrap it to
about 100 characters or so.  In some contexts, the first
line is treated as the subject of an email and the rest of
the text as the body.  The blank line separating the
summary from the body is critical (unless you omit the body
entirely); tools like rebase can get confused if you run
the two together.

Further paragraphs come after blank lines.

  - Bullet points are okay, too

  - Typically a hyphen or asterisk is used for the bullet,
    preceded by a single space, with blank lines in
    between, but conventions vary here

Emoticons

Consider starting the commit message with an applicable emoji:

• TODO Add feature
• 📝 :memo: when writing docs.
• TODO for refactoring and improving the format/structure of the code
• 🐛 :bug: for bugfix
• 🎨 :art: when add some UI features or changes
• ⬆️ :arrow_up: Upgrading, setting new versions of dependencies