type (scope): subject
BLANK LINE
body
BLANK LINE
footer


subject & body:

  • First line is 50 characters or less
  • Then a blank line
  • Remaining text should be wrapped at 72 characters

Ref: 50/72 formatting

type(scope): subject

type:

  • 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 tests or correcting existing tests
  • build Changes that affect the build system, CI configuration or external dependencies (example scopes: gulp, broccoli, npm)
  • chore: Other changes that don’t modify src or test files

scope

The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages).

none/empty: style, test, refactor, docs

subject

add ~.md

Body

commit reason, why change

  • 不兼容的变动：与上一个版本不兼容，则 Footer 部分以 BREAKING CHANGE 开头
  • 关闭 Issue：commit 针对某个 issue，在 Footer 中可以写上 Closes #123

Reference