よもやま話β版

よもやま話を書きます

英語のcommitメッセージをそれっぽくするためにやっていること

自分がいま管理しているリポジトリは引き継ぎしたものだ。 元々commitメッセージを英語で書く方針で始まったようなので、自分もそれを拙いながらも継続している。 とはいえ母国語でないので時々怪しい文章を書いてしまうし、レビューしてくれるひともいない*1。 そんな状況でもどうにか将来 git log を叩いた人へ何が起こっていたのか伝わるように頑張っている。 現時点で、少しでもマシな英語のcommitメッセージを生成するためには何をしているのかを書いてみる。

動詞で始める

Update ~Remove ~ とか動詞から始める。 これは色んなところで良く言われるコツらしいので鉄板なのではないだろうか。

Git でより良いコミットメッセージを書く方法 - yu8mada
gitにおけるコミットログ/メッセージ例文集100
ネイティブと働いて分かった英語コミットメッセージの頻出動詞10つ

Google翻訳に意味が通じるか聞いてみる

それっぽく書いてみたら、とりあえずGoogle翻訳にぶち込んで英->日翻訳で意味が通じるかどうかチェックする。 変な意味になってしまっていたら再考する。

f:id:beta_chelsea:20181025131211p:plain:w500

Grammarlyに文法チェックを頼む

ただ、Google翻訳は優しすぎて、適当な文法でもそれらしく翻訳してくれてしまう。 文法がおかしいかどうか、Grammarlyにぺッと貼ってチェックしてもらっている。

Grammarly: Free Writing Assistant 英語の文法チェックに!秀逸な英文校正ツール「Grammarly(グラマリー)」の使い方 - Life is colourful.

f:id:beta_chelsea:20181025131624p:plain:w500

課金するともっと良い表現などを教えてくれるようだが、無料範囲でも文法上まずいところを指摘してくれる機能がある。 GoogleChrome向けのアドオンもある。アドオンを入れておくと閲覧中のページで英文を入力したときにすぐチェックしてくれる。 Google翻訳上でもアドオンが有効になっているとすぐさま指摘を入れてくれる。

f:id:beta_chelsea:20181025132219p:plain:w500 f:id:beta_chelsea:20181025132226p:plain:w500

冠詞の aan かとか The とか複数形にすべきかどうかとか三人称単数とか、英文において気にするべきところは色々あるが、Grammarlyがまるっと面倒をみてくれるのでとても助かっている。

ちなみに

ちなみに、個人プロジェクトだったら、自分は速度/理解度優先で日本語でcommitメッセージ書くと思う。 特に強いこだわりがないとき、これまでの例に倣っていくのが最適かなぁと思っている。

*1:ぼっちエンジニアなので。メンバー鋭意捜索中。