プルリクエストのガイドライン
プルリクエストの提出時とレビュー時に、コントリビューターとレビュアーが従うべき指針
プルリクエストのガイドライン
スムーズで効率的なレビューを行うために、コントリビューターとレビュアーは、プルリクエスト（以下、PRという）を提出・レビューする際に次のガイドラインに従う必要があります。
コントリビューター
- 明瞭なタイトルと説明
- 変更内容をまとめた明確で簡潔なタイトルを使用してください。
- PRで行うこと、変更が必要な理由、および関連する情報を詳しく説明してください。
- Issueへのリンク
- 関連するIssueとPRをリンクさせるために、PRのタイトルに GH-ISSUE-NUMBER を追加してください。 これはすべてのPRに適用されます。
- 小規模で集中した変更
- PRを小さく保ち、単一の問題や機能に焦点を当てることを目指してください。 これにより、レビュワーが理解しフィードバックを提供しやすくなります。
- コードの品質
- コードがプロジェクトのコーディング基準とベストプラクティスに従っていることを確認してください。
- 複雑なロジックの説明が必要な箇所にはコメントを付けてください。
- テスト
- PRを提出する前に、変更を徹底的にテストしてください。
- 該当する場合は、変更を検証するための単体テストまたは統合テストを含めてください。
- ドキュメント
- 必要に応じて、変更を反映させるためにドキュメントを更新または追加してください。
- コミットメッセージ
- conventional commitsの仕様に従った、明瞭でわかりやすいコミットメッセージを添付してください。
- 競合の確認
- PRを送信する前に、マージ競合を最小限に抑えるためにブランチがベースブランチに対して最新であることを確認してください。
レビュアー
- PRを詳細にレビューし、必要なら修正依頼を出すのがレビュアーの役割です。
- 建設的なフィードバックと改善のための提案を提供してください。
- 変更内容がプロジェクトのコーディング基準とベストプラクティスを満たしていることを確認してください。
- 変更が期待どおりに動作することを保証するために、Dokploy 統合を使用して PR をデプロイしてください。
- 必要に応じてドキュメントが適切に更新されているか確認してください。
- 変更内容に納得がいき、すべての確認が完了してから承認してください。