docs: cli 용 문서 업로드 (runbook: 개발, runbook_planner: 기획)
This commit is contained in:
82
.cli/runbook.md
Normal file
82
.cli/runbook.md
Normal file
@@ -0,0 +1,82 @@
|
||||
# .cli/runbook.md
|
||||
|
||||
## 목적
|
||||
|
||||
이 runbook은 CLI 에이전트가 **레포지토리에 변경을 직접 적용**할 때의 표준 절차를 정의한다.
|
||||
모든 작업은 `@.cli/current.md`를 단일 진실(source of truth)로 삼는다.
|
||||
|
||||
또한, 아래 2개 문서를 **항상 존재**시키고 최신 상태로 유지한다.
|
||||
|
||||
- `@.cli/docs/architecture.md`
|
||||
- `@.cli/docs/rules.md`
|
||||
|
||||
---
|
||||
|
||||
## 실행 절차
|
||||
|
||||
### 0) 기본 문서/규칙 확인(필수)
|
||||
|
||||
작업 시작 전 아래 파일이 없으면 생성한다(템플릿은 레포 내 최신본을 우선, 없으면 기본 템플릿 생성).
|
||||
|
||||
- `@.cli/docs/architecture.md`
|
||||
- `@.cli/docs/rules.md`
|
||||
|
||||
> 이 단계는 기능 변경이 아니라 “운영 문서/규칙”의 존재 보장이다.
|
||||
|
||||
### 1) 작업 적용(필수)
|
||||
|
||||
- `@.cli/current.md`를 읽고, 요구사항/Non-scope/AC를 준수하여 **레포지토리에 직접 적용**한다.
|
||||
- 범위가 명시된 경우(수정 파일 지정 등) 그 범위를 벗어나지 않는다.
|
||||
- 불필요한 리팩토링/포맷 변경/스타일 변경은 하지 않는다.
|
||||
|
||||
### 2) 문서 동기화(필수)
|
||||
|
||||
- 이번 작업이 **구조(FSD), import 규칙, 폴더/엔트리 포인트**에 영향을 줬다면,
|
||||
`docs/architecture.md`에 변경사항을 5~15줄 내로 반영한다.
|
||||
- 이번 작업이 **CLI 운용 규칙**에 영향을 줬다면 `.cli/rules.md`를 반영한다.
|
||||
- 단, 문서 업데이트는 “요약/원칙” 수준으로만 하고 장문 작성 금지.
|
||||
|
||||
### 3) 성공 시 하우스키핑(필수)
|
||||
|
||||
- 작업이 성공적으로 적용되면, 즉시 `@.cli/run_housekeeping.md`를 그대로 수행한다.
|
||||
|
||||
---
|
||||
|
||||
## 출력 규칙(최소 출력)
|
||||
|
||||
### 작업 적용 결과 출력(필수)
|
||||
|
||||
아래 3가지만 출력한다.
|
||||
|
||||
1. **수정/생성/삭제된 파일 경로 목록**
|
||||
|
||||
- 경로만, 짧게.
|
||||
- 파일 내용 전체 출력 금지.
|
||||
|
||||
2. **AC 체크 결과**
|
||||
|
||||
- `- [ ]` 형식으로 current의 AC를 그대로 나열하고 `OK/NO`로 표기.
|
||||
|
||||
3. **docs/rules 상태(1줄)**
|
||||
|
||||
- `docs/rules: OK` 또는 `docs/rules: NO (<사유>)`
|
||||
|
||||
### 하우스키핑 결과 출력(1줄)
|
||||
|
||||
- `run_housekeeping: OK` 또는 실패 시 `run_housekeeping: NO (<사유 1줄>)`
|
||||
|
||||
---
|
||||
|
||||
## 절대 금지
|
||||
|
||||
- diff만 출력하고 적용하지 않기
|
||||
- 코드 전체를 응답으로 덤프하기
|
||||
- current 범위를 벗어난 수정(특히 Non-scope 위반)
|
||||
- 임의의 신규 기능 추가
|
||||
- 과도한 설명/장문의 로그 출력
|
||||
|
||||
---
|
||||
|
||||
## 작업 종료 후 정리(필수)
|
||||
|
||||
- 위 작업이 끝나면 `@.cli/ops/run_housekeeping.md` 절차를 그대로 수행하라.
|
||||
Reference in New Issue
Block a user