英語のコミットメッセージの基本の形
Gitの公式ドキュメントは、必須ではないとしたうえで、変更を要約した50文字以内の短い1行で始め、空行をはさんで詳しい説明を書く形を勧めています。最初の空行までがコミットのタイトルとして扱われ、Gitのさまざまな場面で使われます(Git公式ドキュメント)。Git自体の開発ルールでは、変更を命令形(imperative mood)で書くよう求めています。「This patch makes ...」や「I changed ...」ではなく、コードベースに命令するように「make xyzzy do frotz」と書く形です(Git公式ドキュメント)。
Fix crash when the cart is empty
The checkout screen crashed when the last
item was removed, because the total was
calculated on an empty list. Return early
and show the empty state instead.
1行目は「何をしたか」、本文は「なぜそうしたか」。差分を見れば分かることより、差分からは分からない理由を書くと、あとで読む人の役に立ちます。
コミットメッセージでよく使う英語の動詞20
| 動詞 | 使う場面 | 例 |
|---|---|---|
| Add | 機能・ファイル・テストを追加 | Add CSV export to reports |
| Fix | バグを直す | Fix login error on Safari |
| Update | 既存のものを更新 | Update README with setup steps |
| Remove | 削除 | Remove unused imports |
| Refactor | 動作を変えずに構造を整理 | Refactor payment service into smaller classes |
| Rename | 名前を変更 | Rename userId to accountId |
| Move | 場所を移す | Move date helpers to utils |
| Improve | 改善 | Improve error message for invalid email |
| Bump | バージョンを上げる | Bump axios to 1.7.2 |
| Revert | 取り消す | Revert "Add dark mode toggle" |
| Replace | 置き換える | Replace moment.js with date-fns |
| Simplify | 簡潔にする | Simplify date parsing |
| Handle | ケースの処理を追加 | Handle timeout in API client |
| Prevent | 防ぐ | Prevent double submit on checkout |
| Allow | できるようにする | Allow users to change their email |
| Support | 対応する | Support Japanese file names |
| Extract | 切り出す | Extract validation into a function |
| Implement | 実装する | Implement password reset flow |
| Document | 文書化する | Document the retry policy |
| Clean up | 片づける | Clean up old feature flags |
よくある間違いと直し方
| よくある書き方 | よりよい書き方 | 理由 |
|---|---|---|
| Fixed bug | Fix crash on empty cart | 何を直したか分からない。過去形より命令形 |
| Update | Update iOS deployment target to 17 | 何を更新したかを書く |
| Fixing the login issue. | Fix login redirect loop | -ing形と末尾のピリオドは使わないのが一般的 |
| Various fixes | コミットを分ける | 1コミット1変更にすると、1行で書ける |
| fix typo | Fix typo in installation guide | 場所を書くと、履歴から探しやすい |
Conventional Commitsの書き方
「型: 説明」の形にそろえるルールがConventional Commitsです。fix: はバグの修正、feat: は新機能で、それぞれセマンティック バージョニングのPATCHとMINORに対応します。BREAKING CHANGE: のフッターや型のあとの ! は互換性のない変更(MAJOR)を表します。ほかにも build:、chore:、ci:、docs:、style:、refactor:、perf:、test: などの型が推奨例として挙げられています(Conventional Commits)。
| 英語 | 意味 |
|---|---|
| feat(auth): add Google sign-in | 新機能:Googleログインを追加 |
| fix: handle null avatar URL | 修正:アバターURLがnullの場合を処理 |
| docs: fix typo in README | ドキュメント:READMEのタイプミスを修正 |
| refactor!: drop support for Node 16 | 互換性のない変更:Node 16のサポートを終了 |
日本語と英語、どちらで書く?
決め手はチームのルールです。海外のメンバーがいる、OSSとして公開している、将来ほかの国のチームに引き継ぐ可能性があるなら英語が向いています。いちばん避けたいのは、同じリポジトリで日本語と英語が混ざることです。迷ったらREADMEやCONTRIBUTINGに「Commit messages in English, imperative mood」と書いておきます。
Devlingoで開発現場の英語を1日10フレーズ
コードレビューやプルリクエストの英語は、Gambit StudioのDevlingo(English for Devs)の「Code Review」「Pull Requests」カテゴリで学べます。全12カテゴリ・3,600以上のフレーズを1日10個ずつ、使う場面と発音ガイド、例文つきで。画面表示は英語などで、日本語には対応していません。