Git commitコメント仕様

990 ワード

当社のGit commit仕様は、プロジェクトのpre-commitフックで検証されています.多くの会社の規範がこのようにして、記録をします.
送信形式:
(): 
//    


例:
fix: feat(0429    ): add 'graphiteWidth' option

       

説明:
type(必須)、scope(オプション)、subject(必須).
(オプション)
(1) type
  • typeはcommitのカテゴリを説明するために使用され、以下の8つの識別のみが使用可能である.
  • br:この項目は特にバグ番号に対して、バグリストのバグ修正状況
  • をテストにフィードバックするためのものである.
  • feat:新機能(feature)
  • fix:バグの修正
  • docs:ドキュメント
  • style:フォーマット(コード実行の変動に影響しない)
  • refactor:再構築(すなわち、新規機能でもバグのコード変動を修正するものでもない)
  • test:追加テスト
  • chore:構築プロセスまたはアシストツールの変動
  • revert:feat(pencil):add'graphiteWidth'option(取り消し前のcommit)
  • (2)scope scopeは、commitの影響の範囲、例えばデータ層、制御層、ビュー層などを説明するために使用され、項目によって異なる.
    (3)subject subjectはcommit目的の簡単な説明であり,50文字を超えない.動詞で始まると、changedやchangesの最初のアルファベットの小文字ではなく、現在の一人称を使用するときに句点(.)を付けません.
    (4)Body部は今回のcommitの詳細な説明であり,複数行に分けることができる.