Codex 코드 리뷰를 사용하면 GitHub pull request에서 중요한 문제를 한 번 더 점검할 수 있습니다. Codex는 pull request의 변경 내용을 살펴보고 리포지터리 지침에 따라 심각한 문제를 중심으로 표준 GitHub 코드 리뷰를 게시합니다. 연구 프리뷰로 제공되는 보안 리뷰는 pull request에 잠재된 보안 이슈를 더 깊이 살펴봅니다.
시작하기 전에
다음 항목을 준비하세요.
- Codex에 연결된 GitHub 리포지터리. 레거시 통합을 설정하려면 Codex Cloud(레거시)를 참고하세요.
- Codex 코드 리뷰 설정에 대한 접근 권한.
- Codex가 리포지터리별 리뷰 지침을 따르도록 하려면
AGENTS.md파일도 준비하세요.
Codex 코드 리뷰 설정하기
자동 리뷰를 설정하려면 Codex에 연결된 GitHub 리포지터리가 있어야 하며, 해당 리포지터리 설정을 변경할 수 있는 GitHub 푸시 권한 또는 관리자 권한이 필요합니다.
- GitHub 리포지터리를 Codex에 연결하세요.
- Codex 설정으로 이동하세요.
- 리포지터리를 선택한 다음 자동 리뷰를 켜세요. 이 옵션은 코드 리뷰 항목에 있습니다.
Codex 리뷰 요청하기
- pull request 댓글에
@codex review를 입력하세요. - Codex가 👀로 반응하고 리뷰를 게시할 때까지 기다리세요.
Codex는 팀원처럼 pull request에 리뷰를 게시합니다. GitHub에서는 우선순위가 높은 위험에 집중할 수 있도록 P0 및 P1 이슈만 리뷰 댓글로 남깁니다.
자동 리뷰 활성화하기
내 pull request에 대해 자동 리뷰 옵션을 켜세요. 이 옵션은 개인 설정 항목에 있으며, Codex 설정에서 찾을 수 있습니다. 리뷰 트리거 항목에서 리뷰를 실행할 시점을 선택하세요. 이 설정은 코드 리뷰가 활성화된 리포지터리에 적용되며, @codex review 댓글을 남길 필요가 없습니다.
Codex가 리뷰할 항목 지정하기
Codex는 리포지터리에서 AGENTS.md 파일을 찾아 해당 코드에 적용되는 리뷰 규칙을 따릅니다. 규칙을 적용할 코드와 가장 가까운 파일에 ## Code Review Rules 섹션을 추가하세요. 필요하면 ### 제목으로 관련 점검 항목을 묶으세요.
예를 들어 실험 결과를 보고하는 서비스에서는 다음 규칙으로 실험에 노출된 후의 행동에 따라 비교 대상 집단이 달라지는 일을 막을 수 있습니다.
## Code Review Rules
### 실험 코호트
- 실험군을 비교할 때는 전환이나 리텐션 등 실험 노출 후의 행동을 기준으로 비교 대상을 걸러내지 마세요.
실험군 배정이나 노출 여부를 기준으로 코호트를 구성하고, 전환은 결과 지표로 보고하세요.리포지터리 전체에 적용할 규칙은 루트의 AGENTS.md에, 서비스별 규칙은 services/experiment_reporting/AGENTS.md처럼 하위 디렉터리의 파일에 작성하세요. Codex는 변경된 각 파일에 루트 지침과 해당 파일에 적용되는 세부 지침을 함께 적용합니다. 따라서 관련 없는 변경 사항을 리뷰할 때는 서비스별 컨텍스트를 고려할 필요가 없습니다.
리뷰어가 자주 설명하는 점검 항목을 간결한 규칙 두세 개로 정리하는 것부터 시작하세요. 규칙을 작성할 때는 다음 사항을 고려하세요.
- 해당 리포지터리에서 영향이 큰 동작에 집중하세요. 어떤 호환성 제약이나 데이터 경계를 확인해야 하는지, 어떤 위험한 사이드 이펙트를 지적해야 하는지, 그 이유는 무엇인지 설명하세요.
- 안전한 방법이나 예외를 명시하세요. Codex가 실제 문제와 의도한 동작을 구분할 수 있도록 충분한 컨텍스트를 제공하세요.
- 적용 범위를 명확히 하고 오래 쓸 수 있는 규칙을 작성하세요. 바뀔 수 있는 함수 이름보다 기대하는 결과를 명시하고, 지침은 적용 대상 코드 가까이에 두세요.
- 기계적으로 확인할 수 있는 항목은 CI에 맡기세요. 서식 검사, 린트 등 같은 입력에 항상 같은 결과를 내는 검사는 리뷰 규칙에서 제외하세요.
대표적인 pull request를 열고 @codex review로 리뷰를 요청하세요. 리뷰 결과와 피드백을 바탕으로 규칙을 다듬고, 불필요한 지적을 유발하는 지침은 적용 범위를 좁히거나 삭제하세요.
코드 리뷰 규칙은 Codex에 지침을 제공합니다. 테스트, 브랜치 보호 규칙, 필수 승인은 여전히 필요합니다.
이번 리뷰에서만 특정 항목을 집중적으로 확인하려면 pull request 댓글에 해당 항목을 명시하세요.
@codex review 데이터베이스 마이그레이션에 문제가 있는지 확인해 주세요
보안 리뷰
보안 리뷰는 pull request의 보안 이슈를 중점적으로 살펴보려는 고객을 위한 추가 리뷰입니다. pull request의 변경 내용과 관련 리포지터리 컨텍스트, 설정된 위협 모델이나 보안 지침을 분석해 코드 리뷰보다 보안 위험을 더 깊이 살펴봅니다.
일반 코드 리뷰에서도 보안 이슈를 발견할 수 있어 코드 리뷰와 보안 리뷰 결과가 일부 겹칠 수 있습니다.
보안 리뷰 설정하기
자세한 설정 방법과 옵션은 보안 리뷰를 참고하세요.
- GitHub 리포지터리를 Codex에 연결하세요.
- Codex 설정으로 이동하세요.
- 리포지터리를 선택하세요. 보안 취약점 리뷰 항목에서 자동 보안 리뷰 옵션을 켜고, 리뷰 항목에서 누구의 pull request를 리뷰할지 선택하세요. 코드 리뷰와 함께 실행하려면 트리거 값을 코드 리뷰를 실행할 때마다로 설정하세요.
보안 리뷰 요청하기
보안 리뷰를 수동으로 요청하려면 pull request에 다음 댓글을 남기세요.
@codex security review
Codex는 리뷰를 진행하는 동안 댓글에 반응을 표시하고, 리뷰가 끝나면 발견한 보안 이슈를 pull request에 직접 게시합니다. 전체 보고서를 보려면 연결된 Codex 작업을 열고 보안 보고서 탭을 선택하세요.
코드 리뷰 문제 해결하기
Codex가 반응하지 않거나 리뷰를 게시하지 않으면 다음 사항을 확인하세요.