$ARGUMENTS를 이 코드베이스에 처음인 엔지니어에게 설명합니다.
경로나 심볼이 주어지지 않았다면 무엇을 설명할지 물어보고 중단합니다.
- 대상을 읽습니다. 해당 대상이 어디에서 사용되는지(임포트/호출자 검색)와 무엇에 의존하는지 찾습니다.
- 다음과 같은 형식으로 설명을 작성합니다:
- 목적: 평범한 언어로 한두 문장.
- 맥락: 누가 호출하고, 무엇을 호출하며, 요청/데이터 흐름에서 어디에 위치하는지.
- 핵심 구성 요소: 가장 중요한 3-6개의 함수, 클래스 또는 섹션. 각각 한 줄로 설명.
- 주의사항: 비직관적인 동작, 사이드 이펙트, 에러 상황, 성능 함정.
- 변경이 필요할 때 시작할 지점: 가장 먼저 열어볼 파일과 함수, 그리고 이를 다루는 테스트.
- 파일 경로와 라인 번호(
path/to/file.py:42)를 인용하여 독자가 바로 이동할 수 있도록 합니다.
사실에 기반하세요. 코드에서 명확하지 않은 부분이 있다면 추측하지 말고 그렇게 말하세요. 어떤 파일도 수정하지 마세요.