chore: Agent Guide 셋업 — agent_guide.git 기반 .agents 재구성 + 프로젝트별 설정
This commit is contained in:
@@ -1,129 +1,129 @@
|
||||
---
|
||||
description: 세션 종료 시 devlog 기록 + git commit + Vikunja 동기화 (끝, 마무리, 커밋해, 완료)
|
||||
description: ?¸ì…˜ 종료 ??devlog 기ë¡<EFBFBD> + git commit + Vikunja ?™ê¸°??(?? 마무ë¦? 커밋?? ?„료)
|
||||
---
|
||||
|
||||
# 세션 종료 프로토콜
|
||||
# ?¸ì…˜ 종료 ?„로? 콜
|
||||
|
||||
작업 완료, "끝", "마무리", "커밋해" 등 요청 시 이 워크플로우를 실행합니다.
|
||||
?‘ì—… ?„료, "??, "마무ë¦?, "커밋?? ???”ì² ?????Œí<C592>¬?Œë¡œ?°ë? ?¤í–‰?©ë‹ˆ??
|
||||
|
||||
// turbo-all
|
||||
|
||||
## 0. 학습 기록 (실패/시행착오 저장)
|
||||
## 0. ?™ìе 기ë¡<C3AB> (?¤íŒ¨/?œí–‰ì°©ì˜¤ ?€??
|
||||
|
||||
이번 세션에서 발생한 실패, 시행착오, 새로 알게 된 사실을 정리합니다:
|
||||
?´ë²ˆ ?¸ì…˜?<3F>서 ë°œìƒ<C3AC>???¤íŒ¨, ?œí–‰ì°©ì˜¤, ?ˆë¡œ ?Œê²Œ ???¬ì‹¤???•리?©ë‹ˆ??
|
||||
|
||||
- [ ] `.agents/references/known-issues.md`에 추가할 항목이 있는지 확인
|
||||
- [ ] 있다면 아래 포맷으로 추가:
|
||||
- [ ] `.agents/references/known-issues.md`??ì¶”ê?????ª©???ˆëŠ”ì§€ ?•ì<E280A2>¸
|
||||
- [ ] ?ˆë‹¤ë©??„래 ?¬ë§·?¼ë¡œ ì¶”ê?:
|
||||
|
||||
```markdown
|
||||
### [날짜] [키워드] — 한줄 요약
|
||||
### [? ì§œ] [?¤ì›Œ?? ???œì¤„ ?”약
|
||||
- **ì¦<C3AC>ìƒ<C3AC>**: ...
|
||||
- **원인**: ...
|
||||
- **해결**: ...
|
||||
- **?<3F>ì<EFBFBD>¸**: ...
|
||||
- **?´ê²°**: ...
|
||||
- **주ì<C2BC>˜**: ...
|
||||
```
|
||||
|
||||
## 1. Devlog 기ë¡<C3AB>
|
||||
|
||||
### Index 업데이트 (필수 — 매 작업)
|
||||
### Index ?…ë<E280A6>°?´íЏ (?„수 ??ë§??‘ì—…)
|
||||
|
||||
오늘 날짜의 index 파일에 완료된 작업 1줄을 추가합니다.
|
||||
?¤ëŠ˜ ? ì§œ??index ?Œì<C592>¼???„료???‘ì—… 1줄ì<E2809E>„ ì¶”ê??©ë‹ˆ??
|
||||
|
||||
- **파일**: `docs/devlog/YYYY-MM-DD.md`
|
||||
- **형식**:
|
||||
- **?Œì<C592>¼**: `docs/devlog/YYYY-MM-DD.md`
|
||||
- **?•ì‹<C3AC>**:
|
||||
```markdown
|
||||
| NNN | HH:MM | 작업 설명 | `커밋해시` | ✅ 또는 🔧 |
|
||||
| NNN | HH:MM | ?‘ì—… ?¤ëª… | `커밋?´ì‹œ` | ???<3F>는 ?”§ |
|
||||
```
|
||||
|
||||
> [!TIP]
|
||||
> - ✅ = 완료, 🔧 = 미완료 (다음 세션에서 이어받기)
|
||||
> - 파일이 없으면 새로 생성 (테이블 헤더 포함)
|
||||
> - ??= ?„료, ?”§ = 미완ë£?(?¤ì<C2A4>Œ ?¸ì…˜?<3F>서 ?´ì–´ë°›ê¸°)
|
||||
> - ?Œì<C592>¼???†ìœ¼ë©??ˆë¡œ ?<3F>성 (?Œì<C592>´ë¸??¤ë<C2A4>” ?¬í•¨)
|
||||
|
||||
### Entry 작성 (선택적 — 필요할 때만)
|
||||
### Entry ?‘성 (? íƒ<C3AD>?????„ìš”???Œë§Œ)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Entry는 **git/Vikunja/wiki에 없는 정보**가 있을 때만 작성합니다.
|
||||
> Entry??**git/Vikunja/wiki???†ëŠ” ?•ë³´**ê°€ ?ˆì<CB86>„ ?Œë§Œ ?‘성?©ë‹ˆ??
|
||||
|
||||
**Entry 작성 기준:**
|
||||
- ✅ 설계 결정이 있었을 때 (왜 A가 아닌 B를 선택했는지)
|
||||
- ✅ 미완료 사항이 있을 때 (다음 세션이 이어받아야 할 맥락)
|
||||
- ✅ 삽질/트러블슈팅이 있었을 때 (같은 실수 방지)
|
||||
**Entry ?‘성 기ì?:**
|
||||
- ???¤ê³„ ê²°ì •???ˆì—ˆ????(??Aê°€ ?„닌 Bë¥?? íƒ<C3AD>?ˆëŠ”ì§€)
|
||||
- ??미완ë£??¬í•???ˆì<CB86>„ ??(?¤ì<C2A4>Œ ?¸ì…˜???´ì–´ë°›ì•„????ë§¥ë<C2A5>½)
|
||||
- ???½ì§ˆ/?¸ëŸ¬ë¸”슈?…ì<E280A6>´ ?ˆì—ˆ????(ê°™ì? ?¤ìˆ˜ ë°©ì?)
|
||||
|
||||
**Entry 불필요:**
|
||||
- ❌ 단순 버그 픽스 (커밋 메시지로 충분)
|
||||
- ❌ 문서 업데이트 (git diff로 충분)
|
||||
- ❌ 이미 Vikunja 태스크에 상세 설명이 있는 경우
|
||||
**Entry 불필??**
|
||||
- ???¨ìˆœ 버그 ?½ìФ (커밋 메시지ë¡?ì¶©ë¶„)
|
||||
- ??문서 ?…ë<E280A6>°?´íЏ (git diffë¡?ì¶©ë¶„)
|
||||
- ???´ë? Vikunja ?œìФ?¬ì—<C3AC> ?<3F>세 ?¤ëª…???ˆëŠ” 경우
|
||||
|
||||
**Entry 파일**: `docs/devlog/entries/YYYYMMDD-NNN.md`
|
||||
**Entry ?Œì<C592>¼**: `docs/devlog/entries/YYYYMMDD-NNN.md`
|
||||
```markdown
|
||||
# 작업 제목
|
||||
# ?‘ì—… ?œëª©
|
||||
|
||||
- **시간**: YYYY-MM-DD HH:MM~HH:MM
|
||||
- **Commit**: `해시`
|
||||
- **Vikunja**: #태스크번호 → done/진행중
|
||||
- **?œê°„**: YYYY-MM-DD HH:MM~HH:MM
|
||||
- **Commit**: `?´ì‹œ`
|
||||
- **Vikunja**: #?œìФ?¬ë²ˆ????done/ì§„í–‰ì¤?
|
||||
|
||||
## 결정 사항
|
||||
- 왜 이 방식을 선택했는지
|
||||
## ê²°ì • ?¬í•
|
||||
- ????ë°©ì‹<C3AC>??? íƒ<C3AD>?ˆëŠ”ì§€
|
||||
|
||||
## 미완료
|
||||
- 남은 작업 (있을 경우)
|
||||
## 미완�
|
||||
- ?¨ì? ?‘ì—… (?ˆì<CB86>„ 경우)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Vikunja 동기화
|
||||
## 2. Vikunja ?™ê¸°??
|
||||
|
||||
> [!CAUTION]
|
||||
> **반드시 `vikunja_helper.py` 사용.** 직접 API 호출 금지.
|
||||
> Vikunja API는 POST 시 body에 없는 필드를 빈값으로 덮어씁니다.
|
||||
> **반드??`vikunja_helper.py` ?¬ìš©.** ì§<C3AC>ì ‘ API ?¸ì¶œ 금ì?.
|
||||
> Vikunja API??POST ??body???†ëŠ” ?„드ë¥?빈값?¼ë¡œ ??–´?<3F>니??
|
||||
|
||||
### 2-1. 커밋 전수 검사
|
||||
### 2-1. 커밋 ?„수 ê²€??
|
||||
|
||||
이번 세션의 **모든 커밋을 하나씩 검사**하고 Vikunja에 매핑합니다.
|
||||
?´ë²ˆ ?¸ì…˜??**ëª¨ë“ ì»¤ë°‹???˜ë‚˜??ê²€??*?˜ê³ Vikunja??매핑?©ë‹ˆ??
|
||||
|
||||
```powershell
|
||||
git log --oneline -20
|
||||
```
|
||||
|
||||
| 커밋 유형 | Vikunja 액션 |
|
||||
| 커밋 ? 형 | Vikunja ?¡ì…˜ |
|
||||
|-----------|-------------|
|
||||
| 기존 태스크 해당 작업 **완료** | `C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\vikunja_helper.py done {ID}` |
|
||||
| 신규 작업 완료 (기존 태스크 없음) | `C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\vikunja_helper.py create "제목" "설명" --done --labels Backend,Priority:High` |
|
||||
| 작업 중 발견된 **미완료 TODO** | `C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\vikunja_helper.py create "제목" "설명" --labels Backend,Priority:Mid` |
|
||||
| 기존 ?œìФ???´ë‹¹ ?‘ì—… **?„료** | `C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\vikunja_helper.py done {ID}` |
|
||||
| ? ê·œ ?‘ì—… ?„료 (기존 ?œìФ???†ì<E280A0>Œ) | `C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\vikunja_helper.py create "?œëª©" "?¤ëª…" --done --labels Backend,Priority:High` |
|
||||
| ?‘ì—… ì¤?발견??**미완ë£?TODO** | `C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\vikunja_helper.py create "?œëª©" "?¤ëª…" --labels Backend,Priority:Mid` |
|
||||
|
||||
> [!IMPORTANT]
|
||||
> 모든 커밋이 기존 또는 신규 태스크에 매핑되었는지 확인.
|
||||
> ëª¨ë“ ì»¤ë°‹??기존 ?<3F>는 ? ê·œ ?œìФ?¬ì—<C3AC> 매핑?˜ì—ˆ?”ì? ?•ì<E280A2>¸.
|
||||
|
||||
### 2-2. 완료 처리
|
||||
### 2-2. ?„료 처리
|
||||
|
||||
```powershell
|
||||
C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\vikunja_helper.py done {TASK_ID}
|
||||
C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\vikunja_helper.py done {TASK_ID}
|
||||
```
|
||||
|
||||
### 2-3. 신규 태스크 생성
|
||||
### 2-3. ? ê·œ ?œìФ???<3F>성
|
||||
|
||||
```powershell
|
||||
C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\vikunja_helper.py create "제목" "설명" --labels Backend,Priority:High
|
||||
C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\vikunja_helper.py create "?œëª©" "?¤ëª…" --labels Backend,Priority:High
|
||||
```
|
||||
|
||||
### 라벨 규칙
|
||||
### ?¼ë²¨ 규칙
|
||||
|
||||
**영역 (필수 1개 이상):** `Backend` / `Frontend` / `Engine` / `Infra` / `Test`
|
||||
**우선순위 (필수 1개):** `Priority:High` / `Priority:Mid` / `Priority:Low`
|
||||
**?<3F>ì— (?„수 1ê°??´ìƒ<C3AC>):** `Backend` / `Frontend` / `Engine` / `Infra` / `Test`
|
||||
**?°ì„ ?œìœ„ (?„수 1ê°?:** `Priority:High` / `Priority:Mid` / `Priority:Low`
|
||||
|
||||
---
|
||||
|
||||
## 3. Wiki 동기화 (해당 시에만)
|
||||
## 3. Wiki ?™ê¸°??(?´ë‹¹ ?œì—<C3AC>ë§?
|
||||
|
||||
| 코드 변경 | 대상 Wiki |
|
||||
| 코드 ë³€ê²?| ?€??Wiki |
|
||||
|-----------|----------|
|
||||
| 서버 변경 | Architecture |
|
||||
| 프론트엔드 변경 | Architecture |
|
||||
| 인프라 변경 | Architecture |
|
||||
| 새 모듈/패키지 추가 | Architecture |
|
||||
| ?œë²„ ë³€ê²?| Architecture |
|
||||
| ?„ë¡ ?¸ì—”??ë³€ê²?| Architecture |
|
||||
| ?¸í”„??ë³€ê²?| Architecture |
|
||||
| ??모듈/?¨í‚¤ì§€ ì¶”ê? | Architecture |
|
||||
|
||||
```powershell
|
||||
C:\ProgramData\miniforge3\envs\gravity_web\python.exe .agents\workflows\helpers\wiki_helper.py update "Architecture" /tmp/wiki_content.md
|
||||
C:\ProgramData\miniforge3\envs\agent_chat\python.exe .agents\workflows\helpers\wiki_helper.py update "Architecture" /tmp/wiki_content.md
|
||||
```
|
||||
|
||||
---
|
||||
@@ -141,25 +141,25 @@ git commit -m "커밋 메시지"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
**커밋 메시지 컨벤션:**
|
||||
**커밋 메시지 컨벤??**
|
||||
```
|
||||
<type>(<scope>): <description>
|
||||
|
||||
type: feat|fix|refactor|test|docs|chore|ci|infra
|
||||
scope: (선택)
|
||||
scope: (? íƒ<C3AD>)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. 최종 체크리스트
|
||||
## 5. 최종 ì²´í<C2B4>¬ë¦¬ìФ??
|
||||
|
||||
> [!WARNING]
|
||||
> 아래 항목 중 하나라도 누락되면 세션 종료를 완료할 수 없습니다.
|
||||
> ?„래 ??ª© ì¤??˜ë‚˜?¼ë<C2BC>„ ?„ë<E2809E>½?˜ë©´ ?¸ì…˜ 종료ë¥??„료?????†ìе?ˆë‹¤.
|
||||
|
||||
- [ ] known-issues 업데이트됨 (새 이슈가 있었다면)
|
||||
- [ ] devlog index 업데이트됨
|
||||
- [ ] devlog entry 작성됨 (필요한 경우만)
|
||||
- [ ] Vikunja 태스크 생성/완료 처리됨 (커밋 전수 검사 기반)
|
||||
- [ ] Wiki 동기화됨 (아키텍처 변경이 있었다면)
|
||||
- [ ] git push 완료
|
||||
- [ ] 사용자에게 완료 보고
|
||||
- [ ] known-issues ?…ë<E280A6>°?´íЏ??(???´ìŠˆê°€ ?ˆì—ˆ?¤ë©´)
|
||||
- [ ] devlog index ?…ë<E280A6>°?´íЏ??
|
||||
- [ ] devlog entry ?‘성??(?„ìš”??경우ë§?
|
||||
- [ ] Vikunja ?œìФ???<3F>성/?„료 처리??(커밋 ?„수 ê²€??기반)
|
||||
- [ ] Wiki ?™ê¸°?”ë<E2809D>¨ (?„키?<3F>처 변경ì<C2BD>´ ?ˆì—ˆ?¤ë©´)
|
||||
- [ ] git push ?„료
|
||||
- [ ] ?¬ìš©?<3F>ì—<C3AC>ê²??„료 ë³´ê³
|
||||
|
||||
Reference in New Issue
Block a user