git

WEBサービス アプリケーション・ツール

【Git】コミットメッセージのサンプル

個人的に SourceTree でソースコードのバージョン管理をしているのですが、(他人に見せることがあっても恥ずかしくないように)コミットメッセージの書き方でいつも悩むので、色々と調査・検索した結果、このメッセージが簡単で分かりやすいのではないかという風になったので、メモとして残したいと思います。

コミットメッセージサンプル(私家版)

フォーマット

1行目:変更内容の要約([コミット種類] タイトル、概要)
2行目:空行
3行目以降:変更した理由(内容、詳細)

コミット種類

多くても面倒なので、以下の4種類で運用。

Fix : バグ修正
Add : 新規(ファイル / コード・機能)追加
Update : 機能修正(バグではない)
Remove : 削除(ファイル / コード)

概要の例

3行目以降はそれぞれの修正や追加内容を書けばよいので、ここでは1行目の概要のサンプルを列挙してみる。

[Fix] タイプミスや誤変換の修正
[Fix] インデントや改行の修正
[Fix] ドキュメント / コメントの文言修正

--

[Add] ビューファイルの追加
[Add] フラグの追加
[Add] マスタ用配列への項目追加

--

[Update] 関数オプションの変更
[Update] 変数名の変更
[Update] スケジュールの取得カラム変更

--

[Remove] 不要コードの削除
[Remove] テストの削除
[Remove] 設定項目の削除

メモ

「編集」と「変更」と「修正」と「更新」の違い

ここでは

資料を整理して、書物等にまとめるのが 編集
物事を変えるのが 変更
不足や不適当なものを改めるのが 修正
改めるけど新しくするのが 更新

と定義。なので、

間違っている場合 ⇒「修正
別のものにしたい ⇒「変更

とすることで、整理できるかも。

Fix(修正)

何かを修正した、という表現では広く Fix が使われる。
「何か」は typo(タイプミスや誤変換) や crash といった単語からメソッド名まで幅広い名詞を取る。
Fix は「何かが正しく動くようにした」ことを示し、正しい動作内容が何かを説明しない。
Fix は typo 以外でのドキュメント修正に対しては(あまり)使わない。

Add(追加 / 追記)

何かを追加した、という表現では非常に広く Add が使われる。
メソッドからテスト、ドキュメントに至るまで大概これでまかなえる。

Update(変更 / 更新)

バグ修正ではない変更・更新には Update を使う。
仕様変更等で関数のオプションを変更する場合は Update。バグの対処での変更の場合は Update ではなく Fix を使用する。

Remove(削除 / 除去)

無駄な何かを単純に除去したなら Remove を使う。

参考文献

-WEBサービス, アプリケーション・ツール
-, , ,