はじめに

リポジトリを初めて扱う場合や、なじみのない機能を担当することになった場合は、コードの変更に取りかかる前に Codex で全体像を把握できます。目的は単に概要を知ることではなく、リクエストフローを整理し、各モジュールの担当範囲を理解して、次に読むべきファイルを特定することです。

使用方法

プロジェクトを初めて扱う場合は、まず Codex にコードベース全体の説明を求めるだけで始められます：

既存のコードベースに新機能を追加する必要がある場合は、特定のシステム領域について Codex に説明を求めることができます。質問の対象範囲を適切に絞るほど、説明はより具体的になります：

1. 理解したい対象に関係するファイル、ディレクトリ、または機能領域を Codex に提示します。
2. リクエストフローを追跡し、ビジネスロジック、トランスポート、永続化、UI をどのモジュールが担っているのか説明するよう求めます。
3. 編集前に、検証、副作用、状態遷移がどこで発生するのか尋ねます。
4. 最後に、次に読むべきファイルと、リスクの高い箇所を尋ねます。

オンボーディングに役立つ回答とは、ファイル名の一覧を示すだけでなく、具体的な見取り図まで得られるものです。回答を読み終えるころには、Codex が主なフローを説明し、リスクの高い部分を明示したうえで、編集を始める前に次に読むべきファイルや重要な確認項目まで案内しているのが理想です。

次に尋ねるべき質問

Codex から最初の回答を得たら、自信を持って最初の編集に着手できるほど説明が具体的になるまで、質問を続けます。効果的な追加質問をすれば、前提条件や隠れた依存関係、変更後に重要となる確認項目を Codex に明示させることができます。

• 実際のビジネスロジックを担うモジュールと、トランスポート層や UI 層を担うモジュールはそれぞれどれですか？
• 検証はどこで行われ、そこでどのような前提条件が担保されていますか？
• このフローを変更する場合、見落としやすい関連ファイルやバックグラウンドジョブはどれですか？
• この領域を編集した後、どのテストやチェックを実行すべきですか？