Markdown All in One Documentation

Commit message

🚧 WIP

"Emoji extension" is finished.

Format

Each commit message consists of a summary, and an optional description. There is one blank line between them.

Each commit description consists of a body, and an optional footer. There is one blank line between them.

Examples

👷 Unify build scripts
1
1
🐛 Rewrite heading processing (#877)


Co-authored-by: GitHub <19864447+web-flow@users.noreply.github.com>
1
2
3
4

Message summary

The summary consists of the following parts. There is one space (U+0020) between them.

  1. One appropriate emoji character at the beginning.

    • See the "Emoji extension" section.

  2. The main part.

    • Use the imperative, present tense.
    • Use sentence-style capitalization.
    • No ., !, or ? at the end.
    • At least 20 characters. Should be not more than 70 characters.

  3. (Optional) Scope.

    • Reserved for future use.

  4. (Optional) Connected issues. *

Message body

Emoji extension

The approved emojis and their precedence are listed as below.

  1. 🐛
  2. ✨
  3. 🏗
  4. 🔥
  5. 🌐
  6. 👷
  7. ✅
  8. ⬆
  9. ⬇
  10. 🔧
  11. 📝

We extend the generic Emoji specification with:

CodeEmoji
U+1F310🌐
U+2B06⬆
U+2B07⬇

  • 🌐 (Improve localization resources): Change only localization resources, such as nls JSON files.

  • ⬆ (Update dependencies): Update dependencies only.

  • ⬇ (Downgrade dependencies): Downgrade dependencies only.

Design explanation

References