@elyun/bylane 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,86 @@
1
+ # byLane 리뷰 템플릿
2
+
3
+ 이 파일을 복사해 프로젝트별로 커스터마이즈하세요.
4
+ `.bylane/bylane.json`의 `review.templateFile`에 경로를 지정하면 적용됩니다.
5
+
6
+ ---
7
+
8
+ ## 코멘트 형식
9
+
10
+ 각 리뷰 코멘트는 아래 형식을 따릅니다:
11
+
12
+ ```
13
+ {severity} {title}
14
+
15
+ {description}
16
+
17
+ {code_example}
18
+
19
+ {suggestion}
20
+ ```
21
+
22
+ ### 필드 설명
23
+
24
+ - `{severity}` — 심각도 레이블 (`[CRITICAL]` / `[HIGH]` / `[MEDIUM]` / `[LOW]`)
25
+ - `{title}` — 문제 제목 (한 줄)
26
+ - `{description}` — 문제 설명 및 이유
27
+ - `{code_example}` — 문제가 있는 코드 예시 (선택, `review.includeCodeExample: false`로 비활성)
28
+ - `{suggestion}` — 수정 방법 또는 개선 예시 코드
29
+
30
+ ---
31
+
32
+ ## 심각도 기준
33
+
34
+ | 심각도 | 기준 | 처리 |
35
+ |--------|------|------|
36
+ | CRITICAL | 버그, 보안 취약점, 데이터 손실 가능성 | 즉시 수정 필요, PR 차단 |
37
+ | HIGH | 잘못된 로직, 성능 심각 저하 | 수정 강력 권장 |
38
+ | MEDIUM | 코드 품질, 가독성, 테스트 누락 | 개선 권장 |
39
+ | LOW | 네이밍, 스타일, 선택적 개선 | 참고용 |
40
+
41
+ ---
42
+
43
+ ## 코드 예시 형식
44
+
45
+ **Before (문제 코드):**
46
+ ```language
47
+ // 문제가 있는 코드
48
+ ```
49
+
50
+ **After (수정 제안):**
51
+ ```language
52
+ // 개선된 코드
53
+ ```
54
+
55
+ ---
56
+
57
+ ## 전체 리뷰 요약 형식
58
+
59
+ ```
60
+ ## 코드 리뷰 요약
61
+
62
+ | 심각도 | 건수 |
63
+ |--------|------|
64
+ | CRITICAL | N |
65
+ | HIGH | N |
66
+ | MEDIUM | N |
67
+ | LOW | N |
68
+
69
+ ### 주요 발견사항
70
+ - ...
71
+
72
+ ### 종합 의견
73
+ ...
74
+
75
+ ---
76
+ {footer}
77
+ ```
78
+
79
+ ---
80
+
81
+ ## 푸터
82
+
83
+ 기본값: `Reviewed by byLane · model: {model}`
84
+
85
+ `{model}` — 실제 사용된 모델명으로 자동 치환됩니다.
86
+ 커스터마이즈 예시: `AI 리뷰 by byLane (claude-sonnet-4-6) · {date}`