GitHubの英語コミットメッセージは定型文でOK!実務で使えるテンプレ集

ⓘ当サイト内のリンクには広告が含まれます。

「新しい機能を追加したからコミットしたいけど、『追加する』ってAddだっけ?Appendだっけ?それともCreate?」
「バグ修正のコミットメッセージで、いつも適当な英語を作ってしまい、後から見返すと自分でも意味がわからない…」

コードの修正自体は5分で終わったのに、それを英語のコミットメッセージにするために翻訳ツールと格闘し、15分も時間を無駄にしてしまう。これは、日本のITエンジニアであれば誰もが通る「あるある」の苦悩です。

結論からお伝えすると、実務のソースコード管理において、複雑な英語の文法や多彩な単語力は一切不要です。ネイティブのエンジニアであっても、コミットメッセージに使用する動詞は「わずか5パターンの定型文」にほぼ限定されています。

この記事では、明日からのPull Request(PR)やコミットですぐにコピペして使い回せる、極めて実践的な英語メッセージのテンプレート集を紹介します。

コミットメッセージは「現在形・命令法」で書くのが鉄則

具体的なテンプレートの前に、GitHubにおける英語コミットメッセージの「絶対に守るべき1つのルール」を理解しておきましょう。

それは、動詞の原形(命令法)から書き始めることです。

日本人の感覚だと、「バグを修正した」という過去のことなので、つい “Fixed a bug” と過去形(ed)を使いたくなります。また、自分がやったことだからと “I added a new feature” と主語(I)を入れたくなるかもしれません。

しかし、英語圏の開発文化においてコミットメッセージは、「If applied, this commit will 〇〇」(このコミットが適用されたら、〇〇するだろう)という文脈のあとに続く言葉として定義されています。そのため、主語を省き、動詞の原形からスタートする “Fix a bug” や “Add a new feature” がグローバルスタンダードなのです。

それでは、実務の9割をカバーできる5つの超・頻出動詞とテンプレートを見ていきましょう。

1. Add(新規追加)

ファイル、機能、パッケージなどを新しく「追加」した時に使用する、最も使用頻度の高い動詞です。

  • Add user authentication feature(ユーザー認証機能を追加)
  • Add error handling for API response(APIレスポンスのエラーハンドリングを追加)
  • Add new images to the assets directory(画像フォルダに新しい画像を追加)

2. Fix(バグ修正)

エラーやバグ、不具合を「修正」した時に使用します。何が問題だったのかを簡潔に添えると、レビュアーに親切です。

  • Fix a typo in the README.md(README.mdの誤字を修正)
  • Fix login error on mobile devices(モバイル端末でのログインエラーを修正)
  • Fix memory leak in the background process(バックグラウンド処理のメモリリークを修正)

3. Update(更新・変更)

既存の機能の仕様を変えたり、ライブラリのバージョンを上げた(アップデートした)場合に使います。新しいものをゼロから作ったわけではない点が「Add」との違いです。

  • Update React version to 18(Reactのバージョンを18に更新)
  • Update UI layout for the settings page(設定ページのUIレイアウトを更新)
  • Update API endpoint to v2(APIのエンドポイントをv2に更新)

4. Remove(削除)

不要になったコード、使われていないファイル、廃止された機能を「削除」する時に使います。Deleteよりも好んで使われます。

  • Remove unused CSS classes(使われていないCSSクラスを削除)
  • Remove deprecated API calls(非推奨になったAPI呼び出しを削除)
  • Remove temporary debug logs(一時的なデバッグ用のログを削除)

5. Refactor(リファクタリング)

機能や動作自体は全く変えずに、コードの内部構造を整理して読みやすくした(リファクタリングした)場合に使います。

  • Refactor user validation logic(ユーザー検証のロジックをリファクタリング)
  • Refactor database queries to improve performance(パフォーマンス向上のため、DBクエリをリファクタリング)

コミットメッセージの先へ進むために

この5つの動詞(Add, Fix, Update, Remove, Refactor)を辞書登録やスニペットツールに設定しておくだけで、あなたのコミット作業にかかる時間は劇的に短縮され、海外のOSS(オープンソース)にそのまま出しても恥ずかしくない綺麗な履歴が作れるようになります。まずは明日、わざと過去形を使わずに「動詞の原形」でコミットをプッシュしてみてください。

しかし、もしあなたが「定型文でのコミットはできるようになったけれど、PR(プルリク)のコメント欄で外国人エンジニアとコードの設計について議論しようとすると、英語が出てこずにフリーズしてしまう」と悩んでいるのであれば、定型文の暗記だけでは壁を越えられません。

本気で技術のディスカッションを英語で成立させたいなら、ITのバックグラウンドを持つプロのビジネス英語講師に「コードレビューのロールプレイ」をお願いし、自分の技術的な主張をロジカルに英語で伝える訓練を積むのが最短ルートです。「Bizmates」なら、あなたの技術的な背景を理解し、現場で相手を不快にさせない洗練されたレビューの英語作法を徹底的にフィードバックしてくれます。