189 lines
5.6 KiB
Markdown
189 lines
5.6 KiB
Markdown
---
|
|
description: 세션 종료 시 devlog 기록 + git commit + Vikunja 동기화 (끝, 마무리, 커밋해, 완료)
|
|
---
|
|
|
|
# 세션 종료 프로토콜
|
|
|
|
작업 완료, "끝", "마무리", "커밋해" 등 요청 시 이 워크플로우를 실행합니다.
|
|
|
|
// turbo-all
|
|
|
|
## 0. 학습 기록 (실패/시행착오 저장)
|
|
|
|
이번 세션에서 발생한 실패, 시행착오, 새로 알게 된 사실을 정리합니다:
|
|
|
|
- [ ] `.agent/references/known-issues.md`에 추가할 항목이 있는지 확인
|
|
- [ ] 있다면 아래 포맷으로 추가:
|
|
|
|
```markdown
|
|
### [날짜] [키워드] — 한줄 요약
|
|
- **증상**: ...
|
|
- **원인**: ...
|
|
- **해결**: ...
|
|
- **주의**: ...
|
|
```
|
|
|
|
## 1. Devlog 기록
|
|
|
|
### Index 업데이트 (필수 — 매 작업)
|
|
|
|
오늘 날짜의 index 파일에 완료된 작업 1줄을 추가합니다.
|
|
|
|
- **파일**: `docs/devlog/YYYY-MM-DD.md`
|
|
- **형식**:
|
|
```markdown
|
|
| NNN | HH:MM | 작업 설명 | `커밋해시` | ✅ 또는 🔧 |
|
|
```
|
|
|
|
> [!TIP]
|
|
> - ✅ = 완료, 🔧 = 미완료 (다음 세션에서 이어받기)
|
|
> - 파일이 없으면 새로 생성 (테이블 헤더 포함)
|
|
|
|
### Entry 작성 (선택적 — 필요할 때만)
|
|
|
|
> [!IMPORTANT]
|
|
> Entry는 **git/Vikunja/wiki에 없는 정보**가 있을 때만 작성합니다.
|
|
|
|
**Entry 작성 기준:**
|
|
- ✅ 설계 결정이 있었을 때 (왜 A가 아닌 B를 선택했는지)
|
|
- ✅ 미완료 사항이 있을 때 (다음 세션이 이어받아야 할 맥락)
|
|
- ✅ 삽질/트러블슈팅이 있었을 때 (같은 실수 방지)
|
|
|
|
**Entry 불필요:**
|
|
- ❌ 단순 버그 픽스 (커밋 메시지로 충분)
|
|
- ❌ 문서 업데이트 (git diff로 충분)
|
|
- ❌ 이미 Vikunja 태스크에 상세 설명이 있는 경우
|
|
|
|
**Entry 파일**: `docs/devlog/entries/YYYYMMDD-NNN.md`
|
|
```markdown
|
|
# 작업 제목
|
|
|
|
- **시간**: YYYY-MM-DD HH:MM~HH:MM
|
|
- **Commit**: `해시`
|
|
- **Vikunja**: #태스크번호 → done/진행중
|
|
|
|
## 결정 사항
|
|
- 왜 이 방식을 선택했는지
|
|
|
|
## 미완료
|
|
- 남은 작업 (있을 경우)
|
|
```
|
|
|
|
---
|
|
|
|
## 2. Vikunja 동기화
|
|
|
|
> [!CAUTION]
|
|
> **반드시 `vikunja_helper.py` 사용.** 직접 API 호출 금지.
|
|
> Vikunja API는 POST 시 body에 없는 필드를 빈값으로 덮어씁니다.
|
|
|
|
### 2-1. 커밋 전수 검사
|
|
|
|
이번 세션의 **모든 커밋을 하나씩 검사**하고 Vikunja에 매핑합니다.
|
|
|
|
```powershell
|
|
git log --oneline -20
|
|
```
|
|
|
|
| 커밋 유형 | Vikunja 액션 |
|
|
|-----------|-------------|
|
|
| 기존 태스크 해당 작업 **완료** | `C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\vikunja_helper.py done {ID}` |
|
|
| 신규 작업 완료 (기존 태스크 없음) | `C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\vikunja_helper.py create "제목" "설명" --done --labels Backend,Priority:High` |
|
|
| 작업 중 발견된 **미완료 TODO** | `C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\vikunja_helper.py create "제목" "설명" --labels Backend,Priority:Mid` |
|
|
|
|
> [!IMPORTANT]
|
|
> 모든 커밋이 기존 또는 신규 태스크에 매핑되었는지 확인.
|
|
|
|
### 2-2. 완료 처리
|
|
|
|
```powershell
|
|
C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\vikunja_helper.py done {TASK_ID}
|
|
```
|
|
|
|
### 2-3. 신규 태스크 생성
|
|
|
|
```powershell
|
|
C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\vikunja_helper.py create "제목" "설명" --labels Backend,Priority:High
|
|
```
|
|
|
|
### 라벨 규칙
|
|
|
|
**영역 (필수 1개 이상):** `Backend` / `Frontend` / `Engine` / `Infra` / `Test`
|
|
**우선순위 (필수 1개):** `Priority:High` / `Priority:Mid` / `Priority:Low`
|
|
|
|
---
|
|
|
|
## 3. 설계 문서 업데이트 (필수)
|
|
|
|
- [ ] `.agent/references/STATUS.md` — 모듈 상태 테이블 업데이트 (변경 있었다면)
|
|
- 기능 추가/제거 → 기능 목록 테이블 업데이트
|
|
- 모듈 변경 → 모듈 상태 + 최근 변경 업데이트
|
|
- 마일스톤 달성 → 최근 마일스톤 추가
|
|
- [ ] `.agent/references/architecture.md` — 구조 변경이 있었다면 업데이트
|
|
|
|
## 4. Wiki 동기화 (로컬 변경 기반)
|
|
|
|
로컬 references 파일이 변경되었는지 확인합니다:
|
|
|
|
```powershell
|
|
git diff --name-only .agent/references/
|
|
```
|
|
|
|
변경된 파일이 있으면 **파일별로** Wiki에 업로드합니다:
|
|
|
|
| 로컬 파일 | Wiki 페이지 |
|
|
|-----------|------------|
|
|
| `STATUS.md` | "Status" |
|
|
| `architecture.md` | "Architecture" |
|
|
|
|
```powershell
|
|
# STATUS.md가 변경된 경우
|
|
C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\wiki_helper.py update "Status" .agent\references\STATUS.md
|
|
```
|
|
```powershell
|
|
# architecture.md가 변경된 경우
|
|
C:\ProgramData\miniforge3\envs\variet-agent\python.exe .agent\workflows\helpers\wiki_helper.py update "Architecture" .agent\references\architecture.md
|
|
```
|
|
|
|
> [!TIP]
|
|
> 변경된 파일이 없으면 이 단계를 건너뜁니다.
|
|
|
|
---
|
|
|
|
## 5. Git Commit & Push
|
|
|
|
```powershell
|
|
git add -A
|
|
git status --short
|
|
```
|
|
```powershell
|
|
git commit -m "커밋 메시지"
|
|
```
|
|
```powershell
|
|
git push origin main
|
|
```
|
|
|
|
**커밋 메시지 컨벤션:**
|
|
```
|
|
<type>(<scope>): <description>
|
|
|
|
type: feat|fix|refactor|test|docs|chore|ci|infra
|
|
scope: (선택)
|
|
```
|
|
|
|
---
|
|
|
|
## 6. 최종 체크리스트
|
|
|
|
> [!WARNING]
|
|
> 아래 항목 중 하나라도 누락되면 세션 종료를 완료할 수 없습니다.
|
|
|
|
- [ ] known-issues 업데이트됨 (새 이슈가 있었다면)
|
|
- [ ] devlog index 업데이트됨
|
|
- [ ] devlog entry 작성됨 (필요한 경우만)
|
|
- [ ] Vikunja 태스크 생성/완료 처리됨 (커밋 전수 검사 기반)
|
|
- [ ] STATUS.md 업데이트됨 (모듈/기능 변경이 있었다면)
|
|
- [ ] Wiki 동기화됨 (변경된 references 파일이 있었다면)
|
|
- [ ] git push 완료
|
|
- [ ] 사용자에게 완료 보고
|