소개

처음 접하는 레포지토리에서 작업하거나 낯선 기능을 맡았을 때는 코드를 수정하기 전에 Codex와 함께 구조를 파악할 수 있습니다. 전체적인 개요를 파악하는 데서 한 걸음 더 나아가 요청 플로우를 따라가며 각 모듈의 역할을 이해하고 다음에 읽어볼 파일을 찾는 것이 목표입니다.

사용 방법

프로젝트를 처음 접한다면 Codex에 코드베이스 전체를 설명해 달라고 요청하세요.

기존 코드베이스에 새 기능을 추가해야 한다면 Codex에 그 기능과 관련된 부분을 설명해 달라고 요청하세요. 범위를 명확히 정할수록 더 구체적인 설명을 얻을 수 있습니다.

1. 파악하려는 기능이나 관련 파일, 디렉터리를 Codex에 알려 주세요.
2. 요청 플로우를 추적하고 비즈니스 로직, 전송, 데이터 영속화, UI를 각각 어떤 모듈이 담당하는지 설명해 달라고 하세요.
3. 코드를 수정하기 전에 어디서 유효성을 검사하고 어디서 사이드 이펙트나 상태 전이가 발생하는지 물어보세요.
4. 마지막으로 어떤 파일을 다음에 읽어야 하고 어떤 부분을 수정할 때 특히 주의해야 하는지 물어보세요.

온보딩에 도움이 되는 답변이라면 파일 이름을 나열하는 데 그치지 않고 코드가 어떻게 연결되는지 구체적으로 보여줘야 합니다. 설명을 듣고 나면 주요 플로우와 주의할 부분, 수정에 앞서 읽어볼 파일이나 점검할 사항을 파악할 수 있어야 합니다.

이어서 물어볼 질문

Codex의 첫 답변을 읽은 뒤에는 자신 있게 첫 수정을 할 수 있을 만큼 설명이 구체적일 때까지 질문을 이어가세요. 후속 질문을 할 때는 코드가 무엇을 전제로 하는지, 숨은 종속성은 무엇인지, 수정 후 어떤 점검이 필요한지 구체적으로 짚어 달라고 하세요.

• 실제 비즈니스 로직은 어느 모듈이 담당하고, 전송 계층과 UI 계층은 각각 어느 모듈이 담당하나요?
• 유효성 검사는 어디서 수행하고, 그 검사를 통과하려면 어떤 전제 조건을 충족해야 하나요?
• 이 플로우를 변경할 때 놓치기 쉬운 관련 파일이나 백그라운드 작업은 무엇인가요?
• 이 부분을 수정한 뒤에는 어떤 테스트나 검사를 실행해야 하나요?