コミットメッセージのルール

目的

この記事ではチームでのGit運用において管理がしやすいよう、
コミットメッセージのルールを決めて統一することが目的です。

フォーマット

1行目 : 変更内容（種類: 要約）
2行目 : 空行
3行目 : 変更した理由（内容、詳細）

1行目

変更の種類は下記から選択してください。

• fix: バグ修正
• add: 新規（ページ・機能）追加
• remove: 削除（ファイル）
• update: 機能修正（バグではない）

要約

詳細も記載するので簡潔に。
【例】アコーディオンメニューの修正

3行目

できる限り詳細に記載します。
【例】アクセシビリティを考慮する必要があったため、<details>タグと<summary>タグでUI実装しました。

「Why」がわかるように

どのように変更したかではなく、なぜコードを変更したのかがわかるように記載します。
なぜならコードの変更履歴だけでは理由がわかりにくいためです。
そのため、変更理由がまとめられる程度の粒度でコミットするのが好ましいです。