Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save sahksas/7f32b9c69b8c46f677e42d4086942b12 to your computer and use it in GitHub Desktop.
Save sahksas/7f32b9c69b8c46f677e42d4086942b12 to your computer and use it in GitHub Desktop.
Semantic Commit Messages

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>(<scope>): <subject>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

feat: 新機能 fix: バグ修正 docs: ドキュメントのみの修正の場合 style: コードの意味に影響を与えない変更 (空白、書式設定、セミコロンの欠落など) refactor: バグ修正も機能追加も行わないコード変更 perf: パフォーマンスを向上させるコード変更 test: 不足しているテストの追加または既存のテストの修正 chore: ドキュメント生成などのビルド プロセスまたは補助ツールとライブラリの変更 revert: リバート PR を作成する場合

References:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment