プルリクエスト

よいプルリクエストの作り方

プルリクエスト（PR）は、Exercismのコードベースの一部に対して、自分が提案する変更を提出する方法です。 これを読みながらPRをまとめているなら、ありがとうございます！ このガイドは、PRの技術面以外の部分をサポートすることを目指しています。そうすることで、気持ちよく作業を進められ、同時にメンテナーチームの助けにもなります。

これからどうなるか

PRの流れは次のとおりです。

  • PRを提出します。
  • 1人以上のメンテナーがPRをレビューし、提案のコメントを残します。 場合によっては、その変更を加えるのが適切かどうかを確認するため、PR全体について話し合うこともあります。
  • PRがマージされ、ウェブサイト上でレピュテーションが付与されます。 あるいは、PRがクローズされます。

PRをマージしてもらうには？

最小限の修正でPRをマージしてもらいやすくするために、事前にできることがいくつかあります。

最も大切なのは、PRを提出する前に、これから加える変更をメンテナーが歓迎してくれるかどうかを確かめておくことです。 そのための一番簡単な方法は、まずGitHubでIssueを立て、これから何をするつもりなのかを説明し、その変更をメンテナーが受け入れられるかどうかを尋ねることです。

Note

ExercismのウェブサイトでTaskを見つけた場合は、新しいIssueを立てる必要はありません。 既存のIssueに、自分が取り組むとコメントしてから進めましょう。

次に大切なのは、PRを開くときに、その中にわかりやすい説明を残すことです。 説明のないPRは、メンテナーにとってものすごく困りものです。コードを読むときに背景がわからないからです。 なぜその変更をしたのかを伝え、PRが対象としているIssueへのリンクを貼り、避けられなかったトレードオフがあれば説明するなど、情報を添えてください。

最後に、PRには1つの改善に関係する変更だけを含めるようにしてください。 改善が複数ある場合は、複数のPRに分けましょう。 そうすれば、メンテナーはより簡単に、より速くレビューでき、自分にとっても楽になります。

どのくらい待てばいいですか？

通常、メンテナーは数日以内にPRをレビューします。 最初の1週間は、追加のコメントでPRを何度も押し上げるのは控えてください。メンテナーはボランティアで忙しい人たちです。できるだけ早くレビューに取りかかります。 7日たっても返信がない場合は、PRに新しいコメントを付けて@exercism/reviewersをメンションしてください。そうすると、より多くのチームメンバーに通知が届きます。

改めて、Exercismへのコントリビュート、ありがとうございます。 楽しく、価値のある経験になることを願っています！