はじめに
参考記載の情報を元に、少し変更を加えた自分用のルールをまとめてみました。
Git初心者は、Gitのコミットメッセージの書き方のライト版がオススメです。
Format
<type>(<scope>): <title>
- 例:
feat(ui): ログイン画面を実装 - typeとtitleは必須、scopeは強く推奨
- 紐づくIssueがある場合は、その番号を
#<issue number>(例:#10)のような形式でtitleの前に付ける - 3行目以降を書くかは任意
type
- どういった種類のコミットなのかが一目で分かるように、コミットの種別を書く
- angular/CONTRIBUTING.mdのTypeに変更を加えたもの
| type | 説明 | scopeの例 |
|---|---|---|
| build | ビルドシステムや外部依存関係に関する変更 | library, package, plugin |
| chore | その他の変更 | log, ci, cd, devcontainer |
| docs | ドキュメントに関する変更 | diagram, setup |
| feat | 機能に関する追加・更新 | web, api, db |
| fix | バグ修正 | web, api, db |
| perf | パフォーマンスチューニング | web, db, infrastructure |
| refactor | リファクタリング | web, api, db, test |
| style | コーディングスタイルに関する変更 | linting, formatting |
| test | テストに関する変更 | unit, e2e, ui, api, db |
| revert | 元に戻す | |
| WIP | Work In Progress |
scope
- typeを補足する役割
- 名詞・動名詞であれば、基本的には何でも良い
title
- 変更内容を簡潔に書く
- 言語(英語or日本語)はチームで統一する
- 命令形・現在形で書く
- 日本語の場合は、「〜を◯◯」や「AをBに◯◯」と書く
（◯◯は追加、更新、修正、削除、変更、移動、などなど）
- 日本語の場合は、「〜を◯◯」や「AをBに◯◯」と書く
- 末尾に句読点やピリオドは付けない
- 長くならないようにする
- 英語 ：50文字以内
- 日本語：25文字以内