Markdown記法のサンプル

目次

サンプル

Gitコミットメッセージのフォーマット

<Prefix>: <Subject>
空行
<Body>
空行
<Footer>
  • Prefix 何をしたかを接頭辞で短くあらわします
  • Subject 何をしたかを短い文章にします
  • Body なぜそれをしたのかを文章にします
  • Footer 補足情報を載せます

Prefix 何をしたのかを英語の動詞にする

動詞 説明
Add: （機能・ファイルなどを）追加する
Fix: （コードなどを）修正する
Improve: （コードなどを）改善する
Update: （パッケージやドキュメントなどを）更新する
Remove: （ファイル名やコードを）除去する
Rename: （ファイル名を）変更する
Move: （AをBに）移動する
Change: （AをBに）変更する

Subject 何をしたのかを文章にする

Subjectには、そのコミットで何をしたのかを短い文章（タイトル）にします。

  • 50字未満を推奨。72文字未満が制限
設計新機能「xxx」を追加する
xxx機能で異常終了する不具合を修正する

Body なぜそれをしたのかを文章にする

Bodyには、追加や修正などが必要だった理由を文章にします。

  • Subjectで表しきれている場合は、省略可

Footer 補足情報の残す

  1. GitLabのチケット番号を書く
  2. ドキュメント情報（ファイルパス・ファイル名）
  3. 不具合管理情報（不具合管理ファイルパス・ファイル名、不具合番号、不具合タイトル）

コミットメッセージサンプル

Add: 設計新機能「xxxx」の初期コミット

新機能「xxx」の結合テストのために、プログラムソースおよびリソースを初期登録する。
本機能を動作されるためには、実行環境に対して、xxxxを実施する必要がある。

#xxxx
Box/*/要件定義書/ 要件定義書（xxx）.doc
Box/*/論理設計書/ 論理設計書（xxx）.doc
Box/*/物理設計書/ 物理設計書（xxx）.doc

Fix: xxx機能で異常終了する不具合を修正

xxx機能でyyyをした際、プログラムが異常終了した。aaaに原因があったため、
bbbするようプログラム対応を行った。
本不具合では、他にxxx機能でも同様に異常終了する可能性があった。

#xxxx
Box/*/ 結合テスト不具合.xlsx、No.101「xxx機能でyyyをすると異常終了する」

参考

その他

Posted by iwadjp