Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.84 KB

COMMIT_MESSAGE_CONVENTION.md

File metadata and controls

55 lines (37 loc) · 1.84 KB
Raw

Commit Message Convention

Fundamental Guide

We love the great How to Write a Git Commit Message guide from Chris Beams. Fundamentally, write a commit message according to the guide.

Commit Message Format

:gitmoji-type: a subject as a short description (#123, #234)

Logger description here if necessary

BREAKING CHANGE: if this commit breaks something

close: #123
ref: #234
  • Any line of the commit message cannot be longer 100 characters!

Type With Gitmoji

Must have an gitmoji for your commit type. Below are some of the commonly used gitmoji. Find the whole type in gitmoji.

  • ✨ Introducing new features.
  • 🐛 Fixing a bug.
  • 📝 Writing docs.
  • 🎨 Improving structure / format of the code.
  • 🔧 Changing configuration files.
  • ✅ Updating tests.

Subject

  • must explain why. The code explains how it behaves.
  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end
  • reference GitHub issues at the end. (#123, #234)

Body

  • use the imperative, present tense: "change" not "changed" nor "changes".
  • the motivation for the change and contrast this with previous behavior.

BREAKING CHANGE

  • This commit contains breaking change(s).
  • must type 💥 in commit title.
  • start description with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

This convention is based on tui.editor, AngularJS and ESLint