Skip to content

[CI] CodeRabbit 커스텀 리뷰 설정 추가 - #6

Merged
kimminna merged 1 commit into
developfrom
ci/root/5-add-coderabbit-config
Jun 23, 2026
Merged

[CI] CodeRabbit 커스텀 리뷰 설정 추가#6
kimminna merged 1 commit into
developfrom
ci/root/5-add-coderabbit-config

Conversation

@kimminna

Copy link
Copy Markdown
Member

ISSUE 🔗

close #5



What is this PR? 🔍

PR마다 실행되는 CodeRabbit AI 리뷰를 Timo 프로젝트 컨벤션에 맞게 커스터마이징하는 .coderabbit.yaml을 추가했습니다.

기존에는 CodeRabbit이 기본 설정으로 동작해 영어로 리뷰가 달리고, 프로젝트 고유 컨벤션(any 금지, Named export, App Router 계층 구조 등)을 인식하지 못했습니다. 이번 PR에서 팀 컨벤션을 리뷰 지침에 직접 반영해 CodeRabbit이 Timo 규칙 기준으로 피드백을 제공하도록 설정했습니다.

리뷰 기본 설정

리뷰 언어를 ko-KR로 설정하고, 피드백 방식을 안내하는 tone_instructions를 추가했습니다. 리뷰 톤은 문제 원인과 개선 방법을 함께 제시하고, 비판보다 개선 제안을 우선하는 방향으로 작성했습니다. PR 본문에 자동으로 붙던 서머리(high_level_summary)는 팀 템플릿과 중복되어 비활성화했습니다.

path_instructions

docs/conventions.mddocs/architecture.md를 기반으로 경로별 리뷰 지침을 작성했습니다.

경로 주요 지침
**/*.{ts,tsx} any 금지, Arrow function Named export, 절대경로 import, A11y, 네이밍 컨벤션
apps/timo-web/app/** App Router 계층 규칙, 도메인 간 import 금지, Zustand에 서버 상태 저장 금지
apps/timo-web/stores/** Zustand 스토어 규칙 (서버 상태 저장 금지, 파생 값은 selector로)
packages/timo-design-system/** apps/* 참조 금지, 단방향 의존성
.github/workflows/** 시크릿 하드코딩, 권한 최소화, 액션 버전 핀닝



To Reviewers

path_instructions의 내용이 docs/conventions.md, docs/architecture.md와 일치하는지 확인 부탁드립니다. 컨벤션이 추가되거나 변경될 때마다 이 파일도 함께 업데이트해야 합니다.

Screenshot 📷



Test Checklist ✔

  • .coderabbit.yaml YAML 문법 이상 없음 확인
  • 실제 PR에서 CodeRabbit 한국어 리뷰 동작 확인 — 머지 후 다음 PR에서 검증 예정

- .coderabbit.yaml 파일을 생성했습니다
- 리뷰 언어를 한국어(ko-KR)로 설정했습니다
- 리뷰 톤 가이드라인(tone_instructions)을 추가했습니다
- 프로젝트 컨벤션 기반 경로별 리뷰 지침(path_instructions)을 추가했습니다
- PR 본문 서머리(high_level_summary)를 비활성화했습니다
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

.coderabbit.yaml 파일을 신규 추가하여 CodeRabbit 리뷰 언어를 한국어(ko-KR)로 설정하고, 자동 리뷰·제외 경로·경로별 컨벤션 지침(TypeScript/React, Next.js App Router, Zustand, 디자인 시스템, GitHub Actions)·chat.auto_reply·finishing_touches.docstrings 옵션을 구성한다.

Changes

CodeRabbit 커스텀 리뷰 설정 추가

Layer / File(s) Summary
CodeRabbit 전체 설정 정의
.coderabbit.yaml
ko-KR 언어 설정, auto_review 활성화, node_modules·dist·.next·coverage 등 제외 경로 지정, 경로별 TypeScript/React 컨벤션·App Router 계층 규칙·Zustand 스토어 규칙·디자인 시스템 패키지 규칙·GitHub Actions 워크플로우 보안 체크리스트 지침 추가, finishing_touches.docstrings 비활성화, chat.auto_reply 활성화를 포함하는 112줄 신규 파일 추가.

예상 코드 리뷰 노력

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 제목이 PR의 주요 변경 사항인 CodeRabbit 커스텀 리뷰 설정 추가를 명확하게 요약하고 있습니다.
Description check ✅ Passed PR 설명이 .coderabbit.yaml 설정 추가, 한국어 언어 설정, 경로별 리뷰 지침 등 변경 사항과 완벽하게 일치합니다.
Linked Issues check ✅ Passed PR이 issue #5의 모든 주요 목표(언어 설정, 톤 지침, 경로별 리뷰 지침, high_level_summary 비활성화)를 충족했습니다.
Out of Scope Changes check ✅ Passed .coderabbit.yaml 파일만 추가되었으며, 모든 변경 사항이 issue #5의 요구 사항 범위 내에 있습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/root/5-add-coderabbit-config

Comment @coderabbitai help to get the list of available commands and usage tips.

@kimminna kimminna self-assigned this Jun 22, 2026
@kimminna kimminna added the 😎 DevOps CI/CD, 자동화, 개발 파이프라인 관리 label Jun 22, 2026
@kimminna kimminna added this to the Project Setup milestone Jun 22, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.coderabbit.yaml (1)

113-113: ⚠️ Potential issue | 🔴 Critical | ⚡ Quick win

YAML 파싱을 깨는 단독 숫자 라인을 제거하세요.

Line 113의 113은 key/value가 아닌 단독 스칼라라서 설정 파일 파싱 실패를 유발할 수 있습니다. 이 줄을 삭제해야 전체 CodeRabbit 설정이 정상 적용됩니다.
참고: YAML 1.2 Spec — https://yaml.org/spec/1.2.2/

🔧 Proposed fix
 chat:
   auto_reply: true
-113
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.coderabbit.yaml at line 113, The .coderabbit.yaml file contains a
standalone scalar value `113` on line 113 that is not a key/value pair, which
violates YAML structure and prevents the configuration file from being parsed
correctly. Locate and delete this standalone number line entirely from the
configuration file to ensure all CodeRabbit settings are applied properly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In @.coderabbit.yaml:
- Line 113: The .coderabbit.yaml file contains a standalone scalar value `113`
on line 113 that is not a key/value pair, which violates YAML structure and
prevents the configuration file from being parsed correctly. Locate and delete
this standalone number line entirely from the configuration file to ensure all
CodeRabbit settings are applied properly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 346bbc5e-cd89-4006-b197-843d0c07f66c

📥 Commits

Reviewing files that changed from the base of the PR and between 2cbcf4e and 0cdadb4.

📒 Files selected for processing (1)
  • .coderabbit.yaml

@kimminna kimminna added the ♦️ 민아 민아상 label Jun 23, 2026

@jjangminii jjangminii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드래빗 세세하게 설정하느라 수고하셨습니다~ 저도 시 없는게 좋아요 ㅎㅎ

Comment thread .coderabbit.yaml
1. 피드백은 명확하고 구체적으로 작성하고, 문제 원인과 개선 방법을 함께 제시하세요.
2. 리뷰는 교육적인 방향을 지향하며, 관련 공식 문서 링크를 함께 추천하세요.
3. 비판보다는 개선 제안을 우선하세요.
4. 칭찬은 짧고 위트 있게 작성하세요.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

위트있게 😎

@yumin-kim2 yumin-kim2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

확인했습니다~!! 수고많으셨어요👍👍

Comment thread .coderabbit.yaml
- "!**/coverage/**"
- "!**/*.snap"

path_instructions:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이런 리뷰 지침도 가능하군요...! 신기합니당

@kimminna
kimminna merged commit 0ebf944 into develop Jun 23, 2026
1 check passed
@kimminna
kimminna deleted the ci/root/5-add-coderabbit-config branch June 23, 2026 15:59
@kimminna kimminna mentioned this pull request Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

♦️ 민아 민아상 😎 DevOps CI/CD, 자동화, 개발 파이프라인 관리

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CI] CodeRabbit 커스텀 리뷰 설정 추가

3 participants