bf-update-conventions

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Update Conventions

更新约定规范

Overview

概述

스프린트 완료 후, 코드 리뷰에서 발견된 패턴과 교훈을 docs/conventions.md에 축적한다. conventions.md는 Convention Guard (Open Code Review 기반 리뷰)의 단일 규칙 소스이다.

迭代完成后，将代码评审中发现的模式和经验积累到docs/conventions.md中。conventions.md是Convention Guard（基于Open Code Review的评审工具）的单一规则来源。

When to Use

使用场景

사용자가
```
/bf-update-conventions
```
를 입력했을 때
```
/bf-archive-sprint
```
완료 후

当用户输入
```
/bf-update-conventions
```
时
```
/bf-archive-sprint
```
完成后

Prerequisites

前置条件

아카이브된 스프린트 존재:
```
docs/archive/{TICKET}/
```
아카이브 내 stories, tech-specs 디렉토리 존재
```
docs/archive/{TICKET}/reviews/
```
디렉토리 존재 (리뷰 결과 파일) — 미존재 시 git log에서 리뷰 관련 커밋 히스토리를 대안으로 분석
docs/conventions.md (없으면 신규 생성 —
```
/bf-spec
```
이 초기 seed를 생성했어야 하나, 미생성 시 이 스킬이 빈 템플릿으로 생성)
권장 실행 순서:
```
/bf-archive-sprint
```
→
```
/bf-metrics
```
(선택) →
```
/bf-update-conventions
```
. 아카이빙 후 실행해야 리뷰 결과에 접근 가능

存在已归档的迭代：
```
docs/archive/{TICKET}/
```
归档目录下存在stories、tech-specs目录
存在
```
docs/archive/{TICKET}/reviews/
```
目录（评审结果文件）——若不存在，则以git log中的评审相关提交历史作为替代进行分析
docs/conventions.md（若不存在则新建——
```
/bf-spec
```
应已生成初始模板，若未生成则本技能将创建空模板）
推荐执行顺序：
```
/bf-archive-sprint
```
→
```
/bf-metrics
```
（可选）→
```
/bf-update-conventions
```
。必须在归档后执行才能访问评审结果

Error Handling

错误处理

아카이브 디렉토리 미존재: "
```
docs/archive/
```
가 없습니다.
```
/bf-archive-sprint
```
를 먼저 실행하세요." 안내
리뷰 파일도 git log도 분석할 데이터가 없으면: "분석할 리뷰 데이터가 없습니다. 스프린트 리뷰 이력이 없으면 건너뛰어도 됩니다." 안내

归档目录不存在：提示“
```
docs/archive/
```
不存在，请先执行
```
/bf-archive-sprint
```
。”
评审文件和git log均无可用分析数据：提示“无可用的评审分析数据。若迭代无评审历史可跳过此步骤。”

Instructions

操作步骤

아카이브된 스프린트의 리뷰 이력을 분석한다:
- 1차 소스:
```
docs/archive/{TICKET}/reviews/*.md
```
  파일들을 읽는다
- 2차 소스 (리뷰 파일 미존재 시):
```
git log
```
  에서 커밋 메시지와 변경 패턴을 분석하여 반복 지적 패턴을 추론한다
- 반복적으로 지적된 패턴 추출
- 블로커로 분류된 이슈 유형 정리
- Convention Guard가 놓친 패턴 식별
사용자에게 발견된 패턴을 제시한다:
- 각 패턴의 발생 빈도
- 대표 사례
- 제안하는 룰 내용
사용자 승인 후 다음을 업데이트한다:
- docs/conventions.md: 새 컨벤션 룰을 적절한 섹션에 추가한다. 이 파일이 Convention Guard(OCR 리뷰)의 단일 규칙 소스이므로, 새 체크 항목도 이 파일에 추가한다. 기존 룰은 삭제하지 않는다 (append-only). 기존 룰 보완·구체화만 허용한다. 섹션 분류 규칙:
  - Core 섹션(아키텍처, 네이밍, 테스트, 코드 스타일)에 해당하면 해당 섹션에 추가
  - 기술 특화 패턴이면 concern-area 섹션(UI 패턴, API 패턴, DB 패턴, 보안 패턴, 인프라 패턴)에 추가
  - concern-area 섹션이 아직 없으면 해당 섹션 헤딩(
```
## {Name} 패턴
```
    )을 새로 생성하여 추가
  - 어느 섹션에도 맞지 않으면 가장 관련 높은 Core 섹션에 추가
- CLAUDE.md: Changelog 섹션에 컨벤션 업데이트 이력을 기록한다. 본문(설계 원칙, 핵심 개념 등)은 수정하지 않는다
git commit을 수행한다:
- 메시지:
```
[{TICKET}] 컨벤션 업데이트
```

分析已归档迭代的评审历史：
- 主要来源：读取
```
docs/archive/{TICKET}/reviews/*.md
```
  文件
- 替代来源（评审文件不存在时）：分析git log中的提交消息和变更模式，推断重复指出的问题模式
- 提取重复出现的问题模式
- 整理被归类为阻塞项的问题类型
- 识别Convention Guard未覆盖的模式
向用户展示发现的模式：
- 各模式的出现频率
- 典型案例
- 建议的规则内容
经用户确认后更新以下内容：
- docs/conventions.md：将新的约定规则添加到合适的章节。由于此文件是Convention Guard（OCR评审工具）的单一规则来源，新的检查项也需添加至此文件。请勿删除现有规则（仅追加）。仅允许补充或具体化现有规则。 章节分类规则：
  - 若属于Core章节（架构、命名、测试、代码风格），则添加到对应章节
  - 若为技术特定模式，则添加到concern-area章节（UI模式、API模式、DB模式、安全模式、基础设施模式）
  - 若concern-area中无对应章节，则新建章节标题(
```
## {Name} 模式
```
    )并添加
  - 若不属于任何章节，则添加到最相关的Core章节
- CLAUDE.md：在Changelog章节记录约定更新历史。请勿修改正文（设计原则、核心概念等）
执行git commit：
- 提交信息：
```
[{TICKET}] 约定规范更新
```

Output Format

输出格式

docs/conventions.md 업데이트 (Convention Guard 규칙 포함)
CLAUDE.md 업데이트 (필요 시)
git commit

更新docs/conventions.md（包含Convention Guard规则）
更新CLAUDE.md（如有需要）
git commit