저장소 가이드
코드 검토 요청 전 준비할 것: 저장소·오류·접근 권한
·
코드 검토를 요청하기 전에 저장소 버전, 오류 재현 순서와 접근 제한을 정리하는 방법입니다. 비밀키와 고객 정보를 제외하고 필요한 자료를 준비하세요.
저장소 링크와 확인할 버전을 준비하세요
- GitHub 등 저장소 URL과 문제가 있는 브랜치 또는 커밋을 기록합니다. 운영 중인 앱이 있다면 공개 가능한 페이지 주소도 함께 적습니다. 비공개 저장소는 공개로 바꾸지 말고 신청 시 비공개 여부를 알린 뒤 필요한 읽기 권한 전달 방법을 협의합니다.
고민을 한 가지 기능부터 설명하세요
- 원하는 결과, 실제 결과, 재현 순서, 처음 발생한 시점을 적습니다. 에러 메시지가 있으면 비밀값을 가린 텍스트를 준비합니다. “전체가 이상해요”라는 설명보다 “결제 완료 후 주문이 표시되지 않아요”처럼 구체적인 설명이 도움이 됩니다.
분석에 불필요한 정보는 보내지 마세요
- API 키, .env 원본, 데이터베이스 비밀번호, 세션 쿠키, 고객 데이터는 신청 내용에 넣지 않습니다. 실행 환경은 변수 이름과 버전 정보로 설명할 수 있습니다. 접근 권한이 필요할 때는 검토 대상과 기간을 먼저 합의하세요.
확인한 사실과 아직 모르는 부분을 구분해 두면 다음 변경의 범위를 좁힐 수 있습니다.
함께 읽기: AI가 만든 코드 이해하기: 레포지터리를 읽는 순서