目次
1. 初めに
個人的にGitを使う際のコミットメッセージの規約をまとめました。
2. コミットメッセージの規約
2.1. コミットメッセージのフォーマット
以下のフォーマットでメッセージを入力します。
| n行目 | メッセージ |
|---|---|
| 1行目 | [コミット種別] 変更内容のタイトル |
| 2行目 | (空行) |
| 3行目以降 | 変更内容の詳細 |
2.2. コミット種別
コミットが大まかにどのような内容なのかを分別します。
コミット種別がd_xxxの場合はドキュメントや処理に無関係なファイルが対象です。
c_xxxの場合はコードや設定ファイルが対象となります。
| コミット種別 | 意味 |
|---|---|
| d_add | ドキュメントを追加する |
| d_upd | ドキュメントを更新する |
| d_del | ドキュメントを削除する |
| c_add | 機能を追加する |
| c_mod | コードを変更・改善する |
| c_fix | コードのバグを修正する |
| c_rem | コードを削除する |
2.3. 変更内容のタイトル
そのコミットで行ったことを簡潔にコミット種別も含めて50文字以内で記入します。
また、1つのコミットで2つ以上にならないようにします。
2.4. 変更内容の詳細
そのコミットで行ったことを詳細に1行ごとに72文字以内で記入します。
また、バグ修正の場合はそのバグが発生した理由を記入します。
3. コミットメッセージの例
コミット種別ごとにメッセージの例を示します。
[d_add] 参照ライブラリ管理簿を作成
[d_upd] README更新
[c_add] レート制限表示を実装
[c_mod] リファクタリングを実施
ロジックを変更
- 条件文の可読性を改善
[c_fix] Jekyllビルドが一部スキップされる件を修正
ワークフローファイルのステップでタイムゾーン設定を追加
投稿日時を未来と認識したため
4. 最後に
今回はコミットメッセージの規約をまとめました。 これで一定のルールに基づいて変更履歴を管理できます。