Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
49 lines (36 sloc) 1.69 KB

Commit Message Convention

Commit Message Format

<Type>: Short description (fix #1234)

Logger description here if necessary

BREAKING CHANGE: only contain breaking change
  • Any line of the commit message cannot be longer 100 characters!

Revert

revert: commit <short-hash>

This reverts commit <full-hash>
More description if needed

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Subject

  • 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. If the commit doesn’t completely fix the issue, then use (refs #1234) instead of (fixes #1234).

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).
  • start 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 AngularJS and ESLint

You can’t perform that action at this time.