エンジニア英語

コミットメッセージを英語で書く方法と例文

簡単な答え

コミットメッセージを英語で書くときは、「Fix login error on Safari」のように動詞の原形(命令形)で始め、1行目を50文字ほどに収めるのが基本です。Gitの公式ドキュメントも、短い1行の要約、空行、詳しい説明という形を勧めています。Devlingoでは、こうした開発の英語を毎日学べます。

更新日 4 分で読めますGambit Studio

インストールなしで使う →ブラウザで無料、登録不要

英語のコミットメッセージの基本の形

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 bugFix crash on empty cart何を直したか分からない。過去形より命令形
UpdateUpdate iOS deployment target to 17何を更新したかを書く
Fixing the login issue.Fix login redirect loop-ing形と末尾のピリオドは使わないのが一般的
Various fixesコミットを分ける1コミット1変更にすると、1行で書ける
fix typoFix 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個ずつ、使う場面と発音ガイド、例文つきで。画面表示は英語などで、日本語には対応していません。

出典

  1. Git公式ドキュメント「git-commit」(DISCUSSION)
  2. Git公式ドキュメント「SubmittingPatches」
  3. Conventional Commits 1.0.0(日本語訳)

よくある質問

よく聞かれる質問に、出典つきで答えます。

コミットメッセージは過去形(Fixed)で書いてもいい?
間違いではありませんが、命令形(Fix)が一般的です。Git自体の開発ルールも命令形で書くよう求めています(Git公式ドキュメント)。チームの慣習があればそちらを優先します。
1行目は何文字までが目安?
Gitの公式ドキュメントは50文字以内の短い1行を勧めています(Git公式ドキュメント)。
先頭は大文字?末尾にピリオドはつける?
大文字で始めて、末尾のピリオドはつけないのが一般的です。Conventional Commitsでは「fix: handle ...」のように型のあとを小文字で書く例が多く見られます。
コミットメッセージは日本語と英語どちらがいい?
チームのルールが最優先です。海外メンバーやOSSがあるなら英語、全員が日本語話者なら日本語でも問題ありません。混在だけは避けます。
AIツールにコミットメッセージを英語で書かせるときのコツは?
「英語・命令形・1行目は50文字以内・本文に理由」と条件を伝え、出てきた文が差分と合っているかを必ず読んで確かめます。

続けて読む

同じアプリのガイドをもっと。手順と出典つき。

Devlingo無料 · iOS 17.0+
インストールなしで使う入手