pull-request-01jpcvxfxbfm6z9tc89zm9c37d.md•2.42 kB
---
description: プルリクエストの作成とレビューに関する規約とガイドライン
ruleId: pull-request-01jpcvxfxbfm6z9tc89zm9c37d
tags: [development, pull-request, review]
aliases: [pr-guidelines]
globs: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx", "**/*.go", "**/*.rs", "**/*.scala"]
---
# プルリクエストの掟
## プルリクエスト作成前の準備
### コードの品質確認
- ローカルでテストするし、すべてのテストが通過していることを確認する。
- コードフォーマッターを適用する。
- リンターするし、警告がないことを確認する。
- 既存のコーディング規約に従っていることを確認する。
- 不必要なコメントアウトされたコードを含めない。
### セキュリティチェック
- 秘密情報(パスワード、APIキーなど)が含まれていないことを確認する。
- 依存パッケージのアップデートがある場合は、セキュリティ上の影響を確認する。
## プルリクエストの作成
### 基本要件
- 本文にIssueのURLを記載する。
- 進捗報告はIssueに記載し、プルリクエストには含めない。
- 1つのプルリクエストで1つの変更に集中する。
### 説明文の記載
- 変更の目的と概要を明確に記載する。
- 複雑な変更の場合は、変更箇所の説明と理由を詳細に記載する。
- セキュリティ上の懸念がある場合は、その旨を明記する。
### 変更の粒度
- できるだけ小さな変更単位でプルリクエストを作成する。
- 大きな変更の場合は、レビュアーの理解を助けるため段階的に分割する。
## レビュープロセス
### レビュー依頼時
- レビュアに確認して欲しい点を明確に記載する。
- 議論が必要な点はコードコメントで明示する。
### レビューフィードバック対応
- レビューコメントには迅速に対応する。
- 指摘された点は可能な限り修正する。
- 修正が難しい場合は、その理由を説明する。
## マージ前の最終確認
- すべてのレビューコメントが解決されている。
- 最新のメインブランチの変更を取り込んでいる。
- コンフリクトが解消されている。
- CIのチェックがすべて通過している。