コミットメッセージの書き方 - nekoharuyuki/PuzzleRPG-cocos2d GitHub Wiki
コミットメッセージ（フォーマット）
[Prefix] #チケット番号 コミット内容
コミット内容の要約を記載
1行目にはコミット内容の要約を記載します。 GitHub上ではコミットメッセージの1行目のみ表示される箇所が多いので、1行目に何のコミットなのかをわかりやすく記載しておくことは重要です。
さらに要約は3つの要素に分解します。
Prefix
Prefixにはコミットの種類を英単語1つで記載します。 基本的には下記の中から選択します。
| Prefix | 内容 |
|---|---|
| Fix | バグやミスの修正 |
| Add | ファイルや機能の追加 |
| Remove | ソースコードやファイルの削除 |
| Change | ソースコードやファイルの仕様変更 |
| Update | コードや機能の改善 |
| Upgrade | パッケージやドキュメント等の更新 |
| Revert | 変更の取り消し |
チケット番号
次にチケット番号を記載します。チケット番号とはタスクの番号のことで、GitHubでいうとIssueの番号に対応しています。 つまり、コミットメッセージにIssueの番号を記載することでGitHub上でどのIssueに関するコミットなのかを確認しやすくなります。
- 作業が発生した場合、必ずGitHubのIssueを作成します。
- 軽微な修正でGitHubのIssueを作成していない場合は、
XXXと入力します。
コミット内容
最後にコミットの内容を記載します。 コミットにタイトルをつけるイメージで記載します。