コントリビューター向けプルリクエストガイド


Exercismに貢献したいと思ってくださり、ありがとうございます! プルリクエストを作成する前に、優れたプルリクエストの作り方ガイドをお読みください。このガイドは、プルリクエストの非技術的な側面をサポートし、快適に進めながらメンテナンスチームの助けにもなることを目指しています。

このドキュメントには、種類ごとのプルリクエストに応じたExercism固有の追加ガイドラインが含まれています。

演習のプルリクエスト

コンセプト演習やプラクティス演習のプルリクエストは、こうした演習にまつわる多くのルールのため、作成するのは大変に感じられるかもしれません。 そのため、メンテナーがレビューするのに2〜3時間かかり、何十ものコメントが付くこともあります。
そこで、主担当のレビュアーが1人、あなたのプルリクエストにコメントします。

レビューコメントの多さにひるまないでください。作成者と主担当のレビュアーの両方が納得できる形になるまで、演習が何度も書き直されるのはごく普通のことです。

おすすめ

ここでは、プロセスをさらにスムーズにするためのおすすめをいくつか紹介します。

ドキュメントを読む

演習のプルリクエストを作成する前に、コンセプト演習のドキュメント、およびプラクティス演習のドキュメントを必ずお読みください。 事前にドキュメントを読んでおくと、レビューのコメントが減り、プルリクエストがずっと早くマージされるので、とても助かります。

既存の演習を確認する(ある場合)

トラックに既存の演習があるなら、少し時間を取ってそれらを眺め、どのような見た目で、どのように構成されているかを確認してみましょう。

プラクティス演習のプルリクエスト

その変更が本当にproblems-specificationsに属するか考える

プラクティス演習の内容の一部(たとえば導入文)は、problems-specificationsリポジトリで定義されている(共有の)メタデータに由来します。 そうした内容を更新するつもりなら、その変更が他のトラックにも役立つかどうかを考えてみてください。 役立つ場合は、代わりにproblems-specificationsリポジトリにある演習のメタデータへプルリクエストを作成してください。

一般的なおすすめ

頼まれていないレビューは控える

プルリクエストのレビューはすべて、トラックのメンテナーが1人(または複数人)で行います。リポジトリへのすべての変更を承認する責任があるからです。 また、メンテナーがレビューを行うことで、プルリクエストの作成者に矛盾するフィードバックが届くのを防げます。

もちろん、レビューの手助けになるコメントを残したり(特に大きなプルリクエストの場合)、間違いのように見える点に気づいたときは質問したりするのは歓迎です。