GitHub에서 Codex 코드 리뷰 사용하기

Codex 코드 리뷰를 사용하여 GitHub pull request를 한 번 더 면밀하게 검토할 수 있습니다. Codex는 pull request diff를 검토하고, 리포지토리 지침을 따르며, 심각한 문제에 초점을 맞춘 표준 GitHub 코드 리뷰를 게시합니다.

시작하기 전에

다음을 준비해야 합니다.

• 리뷰하려는 리포지토리에 Codex cloud가 설정되어 있어야 합니다.
• Codex 코드 리뷰 설정에 액세스할 수 있어야 합니다.
• Codex가 리포지토리별 리뷰 지침을 따르게 하려면 AGENTS.md 파일이 있어야 합니다.

Codex 코드 리뷰 설정하기

1. Codex cloud를 설정합니다.
2. Codex 설정으로 이동합니다.
3. 리포지토리의 코드 리뷰를 켭니다.

Codex 리뷰 요청하기

1. pull request 댓글에서 @codex review을(를) 멘션합니다.
2. Codex가 반응(👀)하고 리뷰를 게시할 때까지 기다립니다.

Codex는 팀원처럼 pull request에 리뷰를 게시합니다. GitHub에서 Codex는 리뷰 댓글이 우선순위가 높은 위험에 집중되도록 P0 및 P1 문제만 표시합니다.

자동 리뷰 활성화하기

Codex가 모든 pull request를 자동으로 리뷰하도록 하려면 Codex 설정에서 자동 리뷰를 켭니다. 누군가 리뷰를 받을 새 PR을 열 때마다 Codex가 리뷰를 게시하므로 @codex review 댓글이 필요하지 않습니다.

Codex의 리뷰 대상 맞춤 설정하기

Codex는 리포지토리에서 AGENTS.md 파일을 검색하고 해당되는 코드 리뷰 규칙을 따릅니다. 규칙이 적용되는 코드와 가장 가까운 파일에 ## Code Review Rules 섹션을 추가합니다. 관련 검사를 그룹화하면 유용한 경우 ### 제목을 사용합니다.

예를 들어 실험 보고 서비스에서는 노출 이후의 동작으로 인해 비교 코호트가 변경되지 않도록 할 수 있습니다.

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

리포지토리 전체 규칙은 루트 AGENTS.md에, 서비스별 규칙은 services/experiment_reporting/AGENTS.md 같은 중첩 파일에 배치합니다. Codex는 변경된 각 파일에 적용되는 루트 지침과 더 구체적인 지침을 함께 적용하므로 관련 없는 변경 사항에 서비스별 컨텍스트를 포함할 필요가 없습니다.

리뷰어가 자주 설명하는 검사를 명문화한 간결한 규칙 두세 개로 시작하세요. 유용한 규칙은 다음과 같습니다.

• 중요하고 리포지토리에 특화된 동작에 집중합니다. 표시해야 할 호환성 제약, 데이터 경계 또는 안전하지 않은 부작용과 그 중요성을 설명합니다.
• 안전한 경로나 예외를 명시합니다. Codex가 실제 문제와 예상된 동작을 구분할 수 있도록 충분한 컨텍스트를 제공합니다.
• 규칙의 범위를 명확히 하고 지속 가능하게 유지합니다. 변경될 수 있는 함수 이름보다 결과를 중심으로 작성하고, 지침을 적용 대상 코드 가까이에 배치합니다.
• 기계적인 검사는 CI에 맡깁니다. 형식 지정, lint 및 기타 결정론적 검사는 리뷰 규칙에서 제외합니다.

대표적인 pull request를 열고 @codex review을(를) 사용하여 리뷰를 요청합니다. 확인된 내용과 피드백을 바탕으로 규칙을 다듬고, 불필요한 결과를 생성하는 지침은 범위를 좁히거나 삭제합니다.

코드 리뷰 규칙은 Codex에 지침을 제공하지만, 테스트, 브랜치 보호 또는 필수 승인을 대체하지는 않습니다.

일회성으로 특정 항목에 집중하려면 pull request 댓글에 해당 내용을 추가합니다.

@codex review for security regressions

리뷰 결과에 대응하기

Codex가 리뷰를 게시한 후 같은 pull request에 댓글을 하나 더 남겨 문제 수정을 요청할 수 있습니다.

@codex fix the P1 issue

Codex는 pull request를 컨텍스트로 사용하여 cloud chat을 시작하고, 필요한 권한이 있으면 수정 사항을 브랜치에 다시 push할 수 있습니다.

Codex에 다른 작업 요청하기

댓글에서 review 이외의 내용과 함께 @codex을(를) 멘션하면 Codex가 pull request를 컨텍스트로 사용하여 cloud chat을 시작합니다.

@codex fix the CI failures

코드 리뷰 문제 해결하기

Codex가 반응하거나 리뷰를 게시하지 않는 경우 다음을 확인하세요.

• Codex 설정에서 해당 리포지토리의 코드 리뷰를 켰는지 확인합니다.
• pull request가 Codex cloud가 설정된 리포지토리에 속하는지 확인합니다.
• pull request 댓글에서 정확한 트리거인 @codex review을(를) 사용합니다.
• 자동 리뷰의 경우 자동 리뷰를 켰는지, 그리고 pull request 이벤트가 리뷰 트리거 설정과 일치하는지 확인합니다.