導入

みなさん、Git 使ってますか？
私は最近使い始めました。いいですね、Git。全人類が使えばいいと思います。

ところで、Pull Request / Commit のメッセージ、皆さんはどうしていますか？

日本語ですか？　英語ですか？

事例

私は、Brain Hackers にドキュメントのライターとして参加させていただいています。

私がはじめて参加した時にはすでにいくつか Pull Requests が Closed の状態で鎮座していましたが、各 Pull Requests のメッセージは、ほとんどの PR が英語でした。（ちなみに、示し合わせたわけではないようです）

Add, Update, Revise... 様々な単語がひしめいていますね。英語アレルギーの僕だと蕁麻疹が出そうです。

でも、書けたらかっこいいですよね？

この記事では、PR やコミットメッセージで使われやすい動詞を紹介していきます。

英単語	主な意味	用例	備考
Add	追加する	Add README.md	「フォルダ・ファイル名」や「機能」を引数（目的語）にとる
Remove	削除する	Remove README.md	`Add` の対義語
Improve	向上する（させる）	Improve main.py	機能や速度の向上など、比較的小さな更新を意味する場合が多い
Update	更新する	Update README.md	更新があった場合。元の版では内容が古い場合に用いる
Revise	改訂する	Revise README.md	大幅な更新があった場合。書き換えが `Update` より大きい
Fix	修正する	Fix main.py	エラーを修正した場合。元の版では内容が間違っている場合に用いる
Generate	作成する	Generate UUID	`Add` よりも、機械的に生成（追加）したというイメージが強い
Split	分割する	Split files
Adjust	調整する	Adjust format
Change	変更する	Change format	プログラムの作成・修正というよりは、仕様の変更の意味合いが大きい。自動で出力されるファイル名など
Merge	統合する	Merge PR #1 from A	進行中のプルリクと統合する場合に自動メッセージで出力される

Blacken のようにツールによって慣用的に利用されている動詞なんかもあります。

例）Blacken …… Python のコードをフォーマットするツール Black を使用することを示す。

もちろん、参加する団体・会社・組織によっては日本語だったり、その他の言語だったりするかもしれません。
個人のリポジトリであれば、自分で 「日本語でおｋ」 としておくのも良いと思います。

でも、ほかの方が積み上げてきてくださった今までの慣例が英語であったり、ルールによって英語とされているのであれば、統一しておくのがよいでしょう。

そんな「ちょっと」困ったときに、この記事を思い出してもらえたらうれしいです。