👈
英語でPRを書くとき
概要
RubyGemsの開発をしていた際に、英語でのPRの書き方について「そういえばどうするんだろう」と疑問に思いました。
調査をしてみると命令法(imperative mood)での表現が適していそうだと気づきました。
LinuxのSubmitting Patchesの記述
Linuxカーネルの開発プロセスに関する公式ドキュメンテーションでは次のように述べられています。
原文
[[imperative-mood]] Describe your changes in imperative mood, e.g. "make xyzzy do frotz" instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy to do frotz", as if you are giving orders to the codebase to change its behavior. Try to make sure your explanation can be understood without external resources. Instead of giving a URL to a mailing list archive, summarize the relevant points of the discussion.
翻訳
以下は、命令法での説明例です。「このパッチはxyzzyがfrotzを行うようにします」というような形ではなく、「xyzzyにfrotzを行うように指示します」という感じで、あたかもコードベースに対して命令を与えているかのように説明してください。外部リソースを使用せずに理解できるように注意してください。メーリングリストのアーカイブのURLを提供する代わりに、議論の関連するポイントを要約してください。
他のGemのリポジトリも調べてみると、似たようなPRの書き方を多く見かけました。
確かに、この書き方だとどのような変更を加えたいのか明確で良いと思いました。