プルリクエストのガイドライン
プルリクエストの提出時とレビュー時に、コントリビューターとレビュアーが従うべき指針
プルリクエストのガイドライン
スムーズで効率的なレビューを行うために、コントリビューターとレビュアーは、プルリクエスト(以下、PRという)を提出・レビューする際に次のガイドラインに従う必要があります。
コントリビューター
-
明瞭なタイトルと説明
- PRで行うこと、変更が必要な理由、および関連する情報を詳しく説明してください。
- Issueへのリンク
- 関連するIssueとPRをリンクさせるために、PRのタイトルに GH-ISSUE-NUMBER を追加してください。 これはすべてのPRに適用されます。 これはすべてのPRに適用されます。
-
-
コードの品質
- 複雑なロジックの説明が必要な箇所にはコメントを付けてください。
-
テスト
-
レビュアー
-
- conventional commitsの仕様に従った、明瞭でわかりやすいコミットメッセージを添付してください。
-
コントリビューター
レビュアー
- PRを詳細にレビューし、必要なら修正依頼を出すのがレビュアーの役割です。
- 必要に応じてドキュメントが適切に更新されているか確認してください。
- 変更内容に納得がいき、すべての確認が完了してから承認してください。