Codex use case
GitHub での pull requests のレビュー
人がレビューする前に、リグレッションや潜在的な問題を見つけます。
GitHub で Codex のコードレビューを使うと、Codex がリグレッションやテストの不足、ドキュメントの問題を pull request 上で自動的に指摘します。
Best for
- 担当者がマージを承認する前に、Codex のレビュー結果も判断材料にしたいチーム
- 本番稼働中のプロジェクトの大規模なコードベース
Contents
GitHub での pull requests のレビュー
人がレビューする前に、リグレッションや潜在的な問題を見つけます。
GitHub で Codex のコードレビューを使うと、Codex がリグレッションやテストの不足、ドキュメントの問題を pull request 上で自動的に指摘します。
GitHub で Codex のコードレビューを使うと、Codex がリグレッションやテストの不足、ドキュメントの問題を pull request 上で自動的に指摘します。
Related links
Best for
- 担当者がマージを承認する前に、Codex のレビュー結果も判断材料にしたいチーム
- 本番稼働中のプロジェクトの大規模なコードベース
Skills & Plugins
- シークレットや認証、依存関係の変更など、リスクの高い箇所を重点的にレビューします。
| Skill | Why use it |
|---|---|
| Security Best Practices | シークレットや認証、依存関係の変更など、リスクの高い箇所を重点的にレビューします。 |
Starter prompt
使い方
まず、GitHub の組織またはリポジトリに Codex のコードレビューを追加します。詳しくは「GitHub での Codex コードレビュー」をご覧ください。
すべての pull request を Codex が自動でレビューするように設定できます。個別にレビューを依頼するには、pull request に @codex review とコメントします。
Codex がリグレッションや潜在的な問題を指摘した場合は、その pull request に @codex fix it などの追加のプロンプトをコメントとして投稿し、修正を依頼できます。
これにより、クラウドで新しいチャットが始まり、Codex が問題を修正して pull request を更新します。
レビュールールの設定
Codex のレビュー内容をカスタマイズするには、## Code Review Rules セクションを、ルールの適用対象となるコードに最も近い AGENTS.md に追加します。以下はその例です。
## Code Review Rules
### 実験のコホート
- 実験群を比較する際は、コンバージョンや継続利用など、施策への接触後の行動で比較対象を絞り込まないでください。
コホートは実験群への割り当て、または施策への接触に基づいて定義し、コンバージョンは実験の結果として報告してください。リポジトリ全体に適用するルールはルートの AGENTS.md に、サービス固有のルールは該当するサブディレクトリのファイルに記述します。ルールは簡潔にまとめ、指摘すべき挙動を明記します。安全な対処方法や例外があれば、それも記載します。フォーマットと lint のチェックは CI で行います。設定方法やルールの書き方については「Codex のレビュー内容のカスタマイズ」をご覧ください。
