Git Commit Message Format

In the repository we use and enforce the commit message conventions. The conventions are verified using commitlint with Angular config.

conventional-changelog/commitlint stars forks updated release release date

commitlint checks if your commit messages meet the conventional commit format.

Format of the commit message:

1
2
3
4
5
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Example commit message:

1
2
3
4
5
6
fix(middleware): ensure Range headers adhere more closely to RFC 2616

Add one new dependency, use `range-parser` (Express dependency) to compute
range. It is more well-tested in the wild.

Fixes #2310

type Value

  • feat: new feature for the user
  • fix: bug fix for the user
  • perf: performance improvements
  • docs: changes to documentation
  • style: formatting, missing semi colons, etc.
  • refactor: refactoring production code, e.g. renaming a variable
  • test: adding missing tests, refactoring tests; no production code change
  • chore: updating build configuration, development tools or other changes irrelevant to the user
  • build: build tooling, Docker configuration change
  • ci: test runner, Github Actions workflow changes
  • revert: changes that don’t correspond to the above – should be rare!

Example of <type>: <subject>:

1
2
3
4
5
6
7
feat: add beta sequence
fix: remove broken confirmation message
docs: explain hat wobble
style: convert tabs to spaces
refactor: share logic between 4d3d3d3 and flarhgunnstow
test: ensure Tayne retains clothing
chore: add Oyster build script

scope Value

Example <scope> values:

  • init
  • runner
  • watcher
  • config
  • web-server
  • proxy

Blog Site Specific Conventions

Blog Site type Value

  • add: 添加文章、笔记、文档
  • del: 删除文章、笔记、文档
  • update: 更新文章、笔记、文档，一般指有较大的内容变更或补充
  • fix: 修复文章、笔记、文档中的错误，一般指修正一些错误
  • refine: Refine 文章、笔记、文档，一般指微调

Blog Site scope Value

Examples:

  • posts/blahblah
  • notes/blahblah
  • foobar
it/git
参考资料
许可协议

本文由 Calf 原创，采用 CC BY-NC-SA 4.0 许可协议，转载请注明出处。

分享文章

快来参与讨论吧~