ページを正常に表示するには JavaScript を有効にする必要があります。

Nephy Project コミットメッセージ規定 第二版

初版制定 平成29年4月24日

初版施行 平成29年5月1日

第二版 改定 平成30年4月18日

第二版 施行 平成30年5月1日

NephyProjectに属するすべてのリポジトリでは以下のように統一のコミットメッセージの記法を規定します。

Developerチームに属するプロジェクト参加者は、以下の記法を厳守しなければなりません。

これらの記法を予告なしに変更することはありません。

全般的なルール
  1. 英語を使用する
  2. 簡単な英語でも構いません。ただし、固有名詞の場合は日本語ないし、由来する言語の使用を許可します。

  3. 過去形を使用せず、最初に現れる動詞は現在形を用いる
  4. 過去であることが明白であるため、過去形を使用しないでください。以下のプレフィックスはこれに基づいています。

  5. <プレフィックス: > のあとは大文字で始める
  6. 例えば Add: Hoge のようにします。

  7. <プレフィックス: ><英語本文> の形にし、1行で済ませる
  8. コマンドラインでは git commit -m "<コミットメッセージ>" で1行のメッセージでのコミットが可能です。

  9. コミットの詳細を書く必要はない
  10. 上記のように1行のコミットメッセージも構いません。

プレフィックス(接尾辞) のルール

コロン : の後には半角スペースを忘れないよう注意してください。

下記にないプレフィックスを使用したい場合は Adminチームまでご連絡ください。

  • Re-
  • 「再度のコミット」を意味する接頭辞です。この接頭辞のあとに以下の接頭辞を連続することができます。例えばRe-Add: Hoge または ReAdd: Hoge のようにします。

  • Add:
  • 「機能の追加」や「ファイルの追加」を意味します。ただし、「追加」のニュアンスが含まれるコミットに対して、適用することもできます。

  • Fix:
  • 「バグの修正」を意味します。ただし、「修正」のニュアンスが含まれるコミットに対して、適用することもできます。

  • Update:
  • 「小規模の変更(minor-update)」を意味します。ただし、「更新」のニュアンスが含まれるコミットに対して、適用することもできます。

  • Delete:
  • 「機能の削除」や「ファイルの削除」を意味します。ただし、「削除」のニュアンスが含まれるコミットに対して、適用することもできます。

  • Revert:
  • 「コミットの巻き戻し」を意味します。本来、間違ったコミットはするべきではないが、何かしらの事情で「巻き戻し」が必要になる場合にDeleteとの混合をさけるために適用します。

  • Optimize:
  • 「改善(improve)」や「全般的な更新(major-update)」を意味します。Updateは小規模の更新を意味しますが、非常に広範囲を指す更新の場合に適用します。

  • Marge:
  • 「統合」を意味します。

  • Move:
  • 「リソースの移動」を意味します。リソースが移動された時に適用します。

  • Rename:
  • 「名前の変更」を意味します。内部の名前が変更された時に適用します。

  • Extend:
  • 「拡張」を意味します。既存の機能を「拡張」するときに適用します。

文中のルール
  1. 複数のプレフィックスを使用するときには "," で区切る
  2. ただし、プレフィックスごとにコミットを分割するのが好ましい。

  3. 同じプレフィックスで、複数の変更内容があるときは、,で区切る
サフィックス(接尾辞) のルール
  1. "."(ピリオド) を付けない
  2. これはバージョン番号との混同を避けるためです。

以上