はじめに

初めて扱うリポジトリや、まだ詳しく知らない機能でも、コードを変更する前に Codex と一緒に仕組みを把握できます。概要をつかむだけでなく、リクエストがどう処理されるのかをたどり、各モジュールの役割を理解して、次に読むべきファイルを見つけることが目的です。

使い方

プロジェクトに初めて参加する場合は、まず Codex にコードベース全体を説明してもらいましょう。

既存のコードベースに新機能を追加する場合は、システムのうち、その機能に関わる部分を Codex に説明してもらえます。知りたい範囲を明確にするほど、具体的な説明が得られます。

1. 理解したい機能や、それに関連するファイル、ディレクトリを Codex に示します。
2. リクエストの処理の流れをたどり、ビジネスロジック、通信、データの永続化、UI をそれぞれどのモジュールが担っているか説明してもらいます。
3. コードを編集する前に、どこで検証が行われ、どこで副作用や状態遷移が起きるかを尋ねます。
4. 最後に、次に読むべきファイルと、変更時に注意が必要な箇所を尋ねます。

初めてコードを読むときに役立つのは、ファイル名の一覧だけでなく、処理の流れに沿って各ファイルの関係がわかる回答です。編集に取りかかるまでに、Codex の説明から、主な処理の流れ、変更に伴うリスクが高い箇所、次に読むべきファイルや確認すべき点がわかるのが理想です。

次の質問例

Codex から最初の説明を受けたら、自信を持って最初の変更に取りかかれるくらい具体的に理解できるまで、質問を重ねましょう。前提条件や見えにくい依存関係、変更後に確認すべき点を具体的に尋ねると効果的です。

• ビジネスロジックを実装しているのはどのモジュールですか？ 通信層や UI 層はどのモジュールが担当していますか？
• 検証はどこで行われ、そこでどのような前提条件が満たされていることを確認していますか？
• この処理の流れを変更する際に、見落としやすい関連ファイルやバックグラウンドジョブはありますか？
• この部分を編集した後は、どのテストやチェックを実行すべきですか？