プルリクエストのレビュー
このガイドはメンテナー向けです。 これらの特別な人々は、Jekyllのリポジトリの1つ以上に書き込み権限を持ち、他の人々の貢献をマージするのを手伝います。ここに書かれていることは面白いかもしれませんが、すべての人向けではありません。
親切に対応する
何よりも、プルリクエストを親切にレビューしてください。私たちのコミュニティは、歓迎的で包括的な環境を作ってこそ強くなることができます。これをさらに促進するために、Jekyllコミュニティは、すべてのコミュニティメンバーが従うべき行動規範によって統治されています。
絵文字を自由に使用してください
そして感情豊かになりましょう!貢献はプロジェクトを前進させ、プルリクエストが最終的にマージされない場合でも、常に受け取ることを嬉しく思っています。
GitHubブログのMike McQuaidの投稿「プルリクエストを親切に閉じる」は、始めるのに最適な場所です。技術的な完全性や正確性以外の理由でプルリクエストを閉じることが許容されるさまざまなシナリオを説明しています。親切であることの一部は、プルリクエストに迅速に対応し、解決することです。
迅速に対応する
すべてのプルリクエストを1週間以内にレビューできるようにする必要があります。最初のレビューに時間がかかるのは、すべてのメンテナーが同じ週に謎の休暇を取った場合のみです。迅速な対応は、コミュニティメンバーや他のメンテナーからの頻繁で質の高い貢献を促進します。
あなたの返信が著者の返信を必要とする場合は、pending-feedback
タグを追加してください。@jekyllbotは、プルリクエストの著者が応答すると、自動的にタグを削除します。
迅速に解決する
同様に、プルリクエストを迅速に解決することを目指すべきです。プルリクエストがプロジェクトのコア目的や目標に適合しない機能を導入した場合、それが受け入れられない理由を親切に説明して、速やかに閉じます。
可能な限り詳細なコメントを残してください。あなたが要求している変更が必要な理由、またはあなたが尋ねている質問を解決することが重要な理由について、貢献者にコンテキストを提供してください。貢献者に明確に伝えることができるコンテキストが多いほど、貢献者は高品質のパッチを提供できるようになります。
著者の応答がないまま30日以上経過した場合、プルリクエストを閉じることができます。
場合によっては、レビューが数週間続くことがあります。コミュニケーションが続く限り、これは問題ありません。理想的には、すべてのPRは、オープンから30日以内に解決できることが望ましいです。
テストを探す
これがコードの変更の場合、更新または追加された動作のテストはありますか?バグを含むバージョンをリリースすることは避けられませんが、変更がテストされることを保証することは、バグとリグレッションを最小限に抑えるのに役立ちます。
CIがパスする必要がある
コントリビューターに、Travisでの失敗を調査し、レビューを開始する前にパッチを当てるよう求めることは問題ありません。テストが失敗し、テストがパスするまでレビューは行われないことを示すメッセージをコントリビューターに残すと役立ちます。彼らが助けを求めたら、見て、可能であれば支援してください。
2人ルール
プルリクエストは、2人のメンテナーがプルリクエストをレビューし、受け入れ可能であることを示した後、マージできます。2人のレビューアの1人が別の意見を求める場合を除き、3人目を待つ必要はありません。
セキュリティを考える
コミュニティのテーマを使用したり、他の人のサイトを構築したりすることが、組み込みのセキュリティ脆弱性を伴わないようにすることは、ユーザーに対する義務です。ファイルが読み込まれたり書き込まれたりする場所のようなものは、安全に保つことが重要です。Jekyllは、GitHub Pagesなどのホストサービスの基礎でもあり、セキュリティ問題が発生したときにアップグレードできません。