[CodeRabbit] 코드 래빗 프로젝트 설정

프로젝트에 CodeRabbit 도입하기

이번에 캡스톤디자인 프로젝트를 시작하면서 코드 리뷰 자동화 도구인 CodeRabbit 설정을 맡게 되었습니다. AI가 PR을 자동으로 리뷰해주는 도구인데, 설정법을 정리해봤습니다.

 

 

CodeRabbit이란?

CodeRabbit은 GitHub PR에 AI 코드 리뷰를 자동으로 달아주는 도구입니다. PR을 올리면 변경된 코드를 분석해서 문제점, 개선 사항, 요약 등을 코멘트로 남겨줍니다. 팀 단위 프로젝트에서 코드 리뷰 부담을 줄이는 데 유용합니다. (근데 가끔 조금 귀찮긴 합니다...) 

 

 

 

1. CodeRabbit 연동

coderabbit.ai 에 접속 후 GitHub 계정으로 로그인합니다. 연결할 레포지토리를 선택하면 기본 연동은 완료됩니다.

 

이때 조직(Organization) 레포지토리라면 주의해야합니다 GitHub 조직에서 OAuth 앱 접근을 제한하는 경우 연동이 막힐 수 있습니다. 이 경우 조직의 Owner가 아래 경로에서 CodeRabbit을 승인해줘야 합니다. 

 

github.com/{조직명} → Settings → Third-party Access → OAuth application policy → CodeRabbit Approve를 해주면 됩니다

 

 

 

2. 설정 파일 위치

레포지토리 루트에 .coderabbit.yaml 파일을 생성합니다.

Backend/
├── .coderabbit.yaml   ← 여기에 생성
├── src/
└── build.gradle

 

3. 설정 파일 작성

아래는 제가 사용한 설정 파일 전체입니다. 각 옵션에 주석으로 설명을 달았습니다.

# ================================================================ #
#                    🐰 CodeRabbit 설정 파일                        #
# ================================================================ #

# 리뷰 언어 설정 - 한국어로 피드백을 받습니다
language: "ko-KR"

# 리뷰어 톤 설정
# CodeRabbit이 어떤 방식으로 피드백을 줄지 방향을 잡아줍니다
tone_instructions: >
  1. 단순히 문제를 지적하는 것에 그치지 않고, 왜 문제인지 원인까지 설명해주세요.
  2. 더 나은 코드를 작성할 수 있도록 관련 레퍼런스나 공식 문서를 함께 제안해주세요.
  3. 잘된 부분은 가볍고 유쾌하게 칭찬해주세요.
  4. 전반적으로 함께 성장하는 동료 개발자처럼 피드백해주세요.

# ================================================================ #
#                        리뷰 상세 설정                              #
# ================================================================ #
reviews:
  # 리뷰 강도 설정
  # assertive(꼼꼼) / chill(부드럽게) 중 선택
  profile: "chill"

  # true로 설정 시, 모든 리뷰 코멘트가 resolve되면 자동으로 승인(Approve)
  request_changes_workflow: false

  # PR 요약
  high_level_summary: true       # PR 전반적인 변경 내용 요약
  changed_files_summary: true    # 파일별 변경 내용 요약

  # 워크스루를 접힌 상태로 표시해 PR 페이지가 너무 길어지는 것을 방지
  collapse_walkthrough: true

  # 코드 흐름을 시각적으로 파악할 수 있는 시퀀스 다이어그램 생성
  sequence_diagrams: true

  # 연결된 이슈를 분석해 리뷰에 맥락을 추가
  assess_linked_issues: true

  # 관련 이슈/PR 자동 링크 (팀 규모가 작아 비활성화)
  related_issues: false
  related_prs: true

  # 레이블 자동 제안/적용 (수동으로 관리)
  suggested_labels: false
  auto_apply_labels: false

  # 리뷰어 추천/자동 할당 (수동으로 지정)
  suggested_reviewers: false
  auto_assign_reviewers: false

  # PR 요약 마지막에 짧은 시 한 편을 추가합니다 🐰
  poem: true

  # -------------------------------------------------------------- #
  #                       자동 리뷰 설정                             #
  # -------------------------------------------------------------- #
  auto_review:
    # PR 생성 시 자동으로 리뷰 시작
    enabled: true
    # 기존 리뷰가 있는 PR에 새 커밋이 추가되면 변경분만 다시 리뷰
    auto_incremental_review: true

# ================================================================ #
#                         채팅 설정                                  #
# ================================================================ #
chat:
  # @coderabbitai 멘션 없이도 PR 코멘트에 자동으로 응답
  auto_reply: true

# ================================================================ #
#                       지식 베이스 설정                              #
# ================================================================ #
knowledge_base:
  # 리뷰 시 최신 문서나 정보를 웹에서 검색해 참고할 수 있도록 허용
  web_search:
    enabled: true

  # 레포에 코딩 컨벤션이나 가이드라인 문서가 있다면 리뷰에 반영
  code_guidelines:
    enabled: true

 

 

이후 PR을 올리면 CodeRabbit이 자동으로 리뷰를 달아줍니다. 수동으로 리뷰를 요청하고 싶을 때는 PR 코멘트에 아래와 같이 입력하면 됩니다.

@coderabbitai review

 

 

 

 

설정 자체는 어렵지 않지만, 조직 레포에서의 OAuth 승인 과정에서 살짝 막혔습니다. 조직 레포를 사용하는 경우 Owner 권한이 있는 팀원과 함께 진행하면 수월하게 설정할 수 있습니다. 팀 프로젝트에서 코드 리뷰 문화를 만들고 싶은 분들께 추천드립니다! 🐰