従うことができる Git コミット メッセージ規則!

1948 ワード
webdev productivity git github テキストリンク
このブログの動機は、すべての情報を 1 か所に集め、業界が従う標準についてより多くの人々に認識してもらうことです.

始めましょう.....

A typical git commit message will look like



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


「type」は以下のいずれかでなければなりません!


  • build : ビルド関連の変更 (例: npm 関連/外部依存関係の追加)
  • chore : 外部ユーザーには表示されないコードの変更 (例: .gitignore ファイルまたは .prettierrc ファイルへの変更)
  • feat : 新機能
  • fix : バグ修正
  • docs : ドキュメント関連の変更
  • refactor : バグ修正も機能追加もしないコード. (例: 変数/関数名の名前変更などの意味変更がある場合に使用できます)
  • perf : パフォーマンスを向上させるコード
  • style : スタイリングに関連するコード
  • test : 新しいテストの追加または既存のテストへの変更

    • 「スコープ」はオプションです


  • スコープは名詞でなければならず、コードベースのセクションのセクションを表します

  • Refer this link for example related to scope

    • "主題"


  • 命令形、現在時制を使用する (例: "added"または "adds"の代わりに "add"を使用する)
  • 末尾にドット (.) を使用しないでください
  • 最初の文字を大文字にしないでください

    • Refer this link for more practical examples of commit messages

    参考文献:


  • https://www.conventionalcommits.org/en/v1.0.0/
  • https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
  • https://github.com/fteem/git-semantic-commits
    • redisのbitmap使用シーン
    asp.Netのフォーム認証(最も簡単な編)