11th-PE-web-study/.coderabbit.yaml at main · DMUMC/11th-PE-web-study · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# ============================================================ #
#                       기본 및 언어 설정                          #
# ============================================================ #
# 리뷰 언어 설정 (ko-KR, en-US, ja-JP 등)
language: "ko-KR"

# 실험적/신규 기능 우선 활성화 여부
early_access: false

# 리뷰 전반에 적용할 AI의 어조 및 페르소나 지침
tone_instructions: "모든 리뷰와 PR 요약은 반드시 한국어로 작성하세요. 풀스택 시니어 개발자 관점에서 엄격하게 피드백해야합니다. 또한 모든 피드백에는 반드시 근거가 있어야합니다. 핵심을 명확히 전달하고 구체적인 코드 수정 예시를 포함하세요."

# ============================================================= #
#                          리뷰 상세 설정                          #
# ============================================================= #
reviews:
  # 리뷰 강도 설정
  # assertive (엄격하고 꼼꼼하게) / chill (부드럽고 핵심 위주로)
  profile: "chill"

  # 모든 리뷰 코멘트가 해결(resolve)되면 자동으로 PR을 승인(Approve) 처리
  request_changes_workflow: false

  # ----------------------------------------------------------- #
  #                       요약 및 시각화                           #
  # ----------------------------------------------------------- #
  # PR 전반적인 변경 내용 고수준 요약
  high_level_summary: true
  # PR 본문에 요약이 삽입될 플레이스홀더 문자열 지정
  high_level_summary_placeholder: "@coderabbitai summary"

  # 파일별 변경 내용 세부 요약
  changed_files_summary: true

  # 워크스루(세부 변경 사항)를 기본적으로 접힘(collapsed) 상태로 출력
  collapse_walkthrough: true

  # 복잡한 로직 및 호출 흐름을 시퀀스 다이어그램(Mermaid)으로 시각화
  sequence_diagrams: true

  # 리뷰 완료 상태 및 메트릭 배지 표시
  review_status: true

  # PR 요약 끝부분에 짧은 축하 시(Poem) 생성 여부
  poem: false

  # ---------------------------------------------------------- #
  #                    이슈 / PR / 레이블 연동                     #
  # ---------------------------------------------------------- #
  # 연결된 이슈(Linked Issue)의 요구사항을 분석하여 PR 반영 여부 검증
  assess_linked_issues: true

  # 연관된 과거 이슈 및 PR 자동 탐색 및 링크
  related_issues: false
  related_prs: false

  # PR 내용 기반 레이블 추천 및 자동 적용
  suggested_labels: false
  auto_apply_labels: false

  # 변경된 코드를 기반으로 적합한 리뷰어 추천 및 자동 할당
  suggested_reviewers: false
  auto_assign_reviewers: false

  # --------------------------------------------------------- #
  #                       파일 필터링 및 제외                     #
  # --------------------------------------------------------- #
  # 리뷰 대상에 포함하거나 제외할 파일 경로 패턴 (Glob 패턴)
  # '!' 접두사는 리뷰에서 제외할 파일을 의미
  path_filters:
    - "!**/*.lock"
    - "!**/package-lock.json"
    - "!**/yarn.lock"
    - "!**/dist/**"
    - "!**/build/**"
    - "!**/*.min.*"
    - "!**/vendor/**"
    - "!**/*.generated.*"

  # --------------------------------------------------------- #
  #                     경로별 맞춤 리뷰 지침                      #
  # --------------------------------------------------------- #
  # 특정 경로의 파일에 대해 특화된 검토 규칙 적용
  path_instructions:
    - path: "src/main/java/**"
      instructions: "RESTful 규약 준수 여부, 입력값 검증(Validation), 예외 처리 구조를 중점적으로 확인하세요."
    - path: "**/*Test.*"
      instructions: "경계값 테스트 및 실패 케이스가 충분히 작성되었는지 확인하세요."

  # ----------------------------------------------------------- #
  #                       자동 리뷰 트리거                          #
  # ----------------------------------------------------------- #
  auto_review:
    # PR 생성 시 자동으로 리뷰 시작
    enabled: true
    # 기존 PR에 새 커밋이 추가될 경우 증분(Incremental) 변경분만 다시 리뷰
    auto_incremental_review: true
    # 드래프트(Draft) 상태의 PR도 리뷰할지 여부
    drafts: false
    # PR 제목에 특정 키워드가 포함되어 있으면 리뷰 생략
    ignore_title_keywords:
      - "[Deploy]"
    # 특정 레이블이 붙었을 때만 리뷰를 시작하도록 제한 (빈 배열이면 제한 없음)
    labels: []

  # ---------------------------------------------------------- #
  #                     정적 분석 도구(Linters) 연동               #
  # ---------------------------------------------------------- #
  tools:
    # ast-grep 정적 분석 규칙 적용
    ast-grep:
      rule_dirs:
        - ".ast-grep"
      packages: []
    # 쉘 스크립트 정적 분석
    shellcheck:
      enabled: true
    # GitHub Checks의 linter/test 결과를 AI 리뷰에 통합
    github-checks:
      enabled: true

# ============================================================ #
#                         채팅 및 상호작용                         #
# ============================================================ #
chat:
  # @coderabbitai 멘션 없이도 PR 코멘트에 자동으로 응답
  auto_reply: true

# ============================================================ #
#                       지식 베이스 설정                           #
# ============================================================ #
knowledge_base:
  # 지식 베이스 인덱싱 전체 제외 여부
  opt_out: false

  # 최신 라이브러리 및 표준 문서 웹 검색 허용
  web_search:
    enabled: true

  # 레포지토리 내 코딩 컨벤션 및 가이드라인 반영
  code_guidelines:
    enabled: true
    # 참고할 문서 파일 경로
    filePatterns:
      - "README.md"

  # 이전 리뷰 피드백 및 사용자 상호작용 학습 반영
  learnings:
    scope: local

  # 과거 이슈 내역을 지식 베이스로 활용
  issues:
    scope: local

  # 과거 병합된 PR 내역을 지식 베이스로 활용
  pull_requests:
    scope: local