読者です 読者をやめる 読者になる 読者になる

git のコミットメッセージ用例集がほしい(2)

もう1年半以上前になるけど、以下のような記事を書いて、
note103.hateblo.jp

ようは「英語のコミットメッセージ用例集」みたいな話で、その時は以下のあたりを紹介したのだけど、

同じ悩みを抱える人が絶えないのか、冒頭の記事には今も時々ブクマが付くのだけど、さすがに書いてからそれなりに時間が経ったせいか、最近自分が参考にするのは上記とちょっと違うので、アップデート版として最近同じ用途でよく見にいく記事を共有したい。

まず、一番良く見るのは以下の2件*1

前者は多めのデータを客観的に解析して抽出したベスト20。
後者は、身の回りの英語ネイティブの人が使っているものを整理したもの。

どちらもそれぞれの切り口でよくまとまっていて、参考にする側としては、結局この両者に共通するものを使えばいいのでは&同時にその背景(使用理由や用例)を把握できれば尚良いのでは、みたいな感じで、大変便利で助かっています。

それ以外だと、リンク集的なものとしてこちらが綺麗にまとまってますね。

いずれにしても、ネイティブのコミットメッセージをデータ解析している前二者はとても説得力があって、アプローチの仕方として良い感じです。

彼らが自然に選択している言葉を知ったり使ったりすることで、よりスムーズなコミュニケーションに至れそう、という気がします。

追記

その後、以下のブックマークをもらってなるほど、と思ったのだけど、

git のコミットメッセージ用例集がほしい(2) - the code to rock

そうそう。欲しい。ただ、日本語でも欲しいのだけど。ダメかな。。。VCSですら使ったことないチームにgitを導入し始めてきて、ここでコミットメッセージも英語でとか言ったら100%ポシャりそう。。。

2016/01/22 07:11
b.hatena.ne.jp

Gitにあまり慣れていないメンバーに使ってもらう時とか、協業の範囲が日本人同士のみに限定されているとかであれば、日本語で書くこと自体は全然いいのでは、と思いました。

上の本文で想定していたのは、協業メンバーが日本人に限定されないOSS的なプロジェクトとか、あるいは勉強的にGitを使う場面なので英語縛りの前提にしていたけど、たんに便利なバージョン管理の道具として使う、という目的を優先する場合には、無理に英語で書いて「結局どういう意味?」みたいになっても本末転倒というか、道具に使われる感じになってしまうので、少なくとも「日本語じゃダメ」ということはないと思います。

ちなみに僕自身も、GitHubに公開するものはなるべく英語で書いてるけど*2、自分だけが使う前提の非公開のレポジトリとか、あとscholaの編集部内(日本人のみ数名)で共有してるレポジトリなんかは結構日英が混在しているというか、とりあえず「この変更内容ちゃんと理解してほしいな」と思うようなのは迷わず日本語で書いてますね。

ただその上で、英語なら上記みたいな用例集というか、「こういう時は大体こういう言い回しにする」というのを抽出しやすいと思うけど、日本語でそういうのって、すぐには思い浮かばないですね・・。上でも本業プロジェクトでは「混在」してると書いたけど、ようは全部日本語にしようと思うと逆に大変というか。「Fix typo」をわざわざ日本語にする意味なさそう、とか。

今後、日本語でコミットメッセージを書く利用者が増えて、サンプルが溜まれば自然にそういう日本語の文例集も出てくるかもしれないけど、そもそもGitを使うような人は海外のプログラマーと協業する場面が多くて、そういう人から順に使い始めるであろう状況を考えると、いわばキャズムを超えるというか、日本人同士だけでGitを使ってしかもそれが全世界公開されてる、という状況が増える&普通になるのを待つ必要があるかもしれないなあ、とも思いました。

*1:実は今日も見てた。で、この記事書こうと思っていたのを思い出して書いた。

*2:外国人からプルリクが来ると想定して、ではなくて他人から見えるところに置く緊張感が学習のモチベーションを高めることを利用して、ということ。