英語でGitコメントを書く(動詞編)

2020/06/19

英語でコミットメッセージを書きたいけど、英語が苦手なゆえに悩むことはありませんか?

今回は、Git Hub にあるLaravelリポジトリのコミットメッセージを参考にして、コミットメッセージの例文集を作成してみようと思います。

 

Gitコミットメッセージの書き方

慣習

Gitの英語でのコミットメッセージの書き方には慣習があります。

慣習にのっとると、より良いコミットメッセージを書くことができます。

1.大文字ではじめる
2.命令形の動詞ではじめる
   → Git自身が自動コミットを作成するときに命令形を使用しているから
3.ピリオドはつけない

 

動詞の使い方

コミットメッセージの基本形は 動詞+名詞 です。

名詞は固有名詞、複数形、不可算名詞が多いです。単数形の場合の冠詞は "a" が使われるか、あるいは省略されます。"the" はあまり使われません。

【例】
・Fix typos
・Fix a typo

 

よく使われる動詞

【〇〇件】→ Git Hubにある "Laravel" リポジトリにあるコミットメッセージの検索結果の数字を表しています。

 

Add:新規(ファイル)機能追加【1,223件】

使い方

Add は to がよく用いられています。

Add A to B(BにAを追加)ex. Add js to import
Add A for B(B用にAを追加)ex. Add test for bug#3116

 

laravelリポジトリのコミット実例

Add sponsor link
Add `links` option to filesystems config
Add ses
Add MAIL_FROM_ADDRESS & MAIL_FROM_NAME to .env file
Add new password rule language line
Add xml schema to phpunit
Add file xeclusions for styleci

 

Fix:バグ修正【806件】

使い方

Fix は、いろいろな前置詞といっしょに用いられています。

Fix に限った話ではありませんが、For の後には、issue の ID などがよく用いられています。

Fix A in B(Bの箇所のAを修正)ex. Fix typo in docs
Fix for A(Aに対する修正)ex. Fix for #4183
Fix A to B(BへのAを修正)ex. Fix link to the spec
Fix A of B(BのAを修正)ex.Fix location of favicon

 

laravelリポジトリのコミット実例

Fix wording
Fix s3 endpoint urlreference
Fix session confg changes
Fix key
Fix conflicts
Fix Typo

 

Update:機能修正(バグではない)【584件】

使い方
Update to A(Aにアップデート)ex. Update to Unicode 6.3.0
Update A to B(AをBに更新する)ex. Update Modernizr to v1.6

 

laravelリポジトリのコミット実例

Update sponsor link
Update CHANGELOG.md
Update app.php
Update composer.json
Update cross-env to the latest
Update number of Laracasts videos
Update .gitignore

 

Remove:削除(ファイル)【387件】

使い方
Remove A from B(BからAを取り除く)ex. Remove Debug from tests
Remove A in B(Bの箇所のAを除去)ex. Remove duplication in render function
Remove unused A(不必要なAを除去)ex. Remove unused code

 

laravelリポジトリのコミット実例

Remove config entry
Remove empty line from phpunit.xml
Remove hyphen on email
Remove register in auth provider
Remove unnecessary variable
Remove auth migration that is now in laravel/ui
Remove controllers that are generated by laravel/ui package

 

Use:使う【381件】

使い方

use は不定詞としてよく用いられます。

to use A(Aを用いるために)ex. Change syntax to use dots
Use A instead of B(Bの代わりにAを用いる)ex. Use ++ instead of +=1
Use A in B(Bの箇所のAを用いる)ex. Use stub in testing
Use A for B(BのためにAを用いる)ex. use Ruby for mocking
Remove use of B(Bを用いるのを除去)ex. Remove use of deprecated method

 

laravelリポジトリのコミット実例

Use MAIL_MAILER in test environment
Use phpunit 0
Use file session driver again
Use laravel/tinker v2
Use Str::random() instead of str_random()
Use correct env name for AWS region from env.example
Use $_SERVER instead of $_ENV for phpunit

 

Change:仕様変更【318件】

使い方
Change A to B(AをBに変更する)ex. Change copyright to 2013
Change to B(Bに変更)ex. Change to lazy Unmount
Change A for B(Bに対してAを変更)ex. Change API for sending handles
Change A in B(B中のAを変更)ex. Change rm usage in docs

 

laravelリポジトリのコミット実例

Change some default settings
Change variable name
Change syntax for validation
Change font to new one
Change name
Change env example
Change indent 

 

Clean:整理(リファクタリング等)【138件】

使い方
Clean up A(Aを整理する)
Cleaning up A(Aを整理する)

 

laravelリポジトリのコミット実例

Clean up
Clean up exception handler
Cleaning up configs
Cleaning up auth code
Cleaning up view
Cleaning up a few things
Cleaning up code

 

Make:~する【103件】

使い方

Make A B といった、A を B にするという形式がよく用いられます。

Make it possibleMake it easier などの使い方がされています。

Make use of A(Aを使用する)
Make it A(Aにする)
Make it A の比較級(よりAにする)
Make sure to A(必ずAするようにする)

 

laravelリポジトリのコミット実例

Make app path steam safe
Make links HTTPS
Make app name configurable in environment file
Make scripts work with Yarn
Make env variables for aws
Make axios automatically send the 'X-CSRF-TROKEN'
Make 503 page more consistent with welcome page
Make TestCase abstract

 

まとめ

Laravelリポジトリのコミットメッセージを解析した結果、一番多く使われている動詞は "Add" (1,223件)でした。

主にドキュメント修正に対して使われるのが "Add" や "Update" を使う傾向にあります。

"Fix" は typo 以外でのドキュメント修正に対して使われることは稀です。(※バグを修正したなら Fix を使います。)

以上です。

 

中学・高校6年分の英語が10日間で身につく本

WEBのスキルと英語は最高のスキルセット!実際に英語の読み書きができるとプログラミングのスキルも格段に上がります。この本は、まったく英語がわからない人には向いていないけど、中学英語ぐらいの基礎ができてる人にとっては、復習用に持って来いの教材です。この本を3周したぐらいには、Gitのコミットメッセージも英語でスラスラ書けるかも!?

Amazonで詳細を見る

オススメ

 
 

本庄マサノリ

仕事で Laravel を使っています。気づいたことや新しい発見など情報を発信していきます。問い合わせはこちら

>> Twitter をフォローする

 

-環境構築