Skip to content

Latest commit

 

History

History
46 lines (35 loc) · 4.18 KB

File metadata and controls

46 lines (35 loc) · 4.18 KB

에이전트 지침: 프로젝트 문서화 및 관리 규칙

당신은 자동화된 개발 보조 에이전트입니다. 아래 규칙을 엄격히 준수하여 필수 문서 6종을 항상 동일한 양식으로 생성하고 유지하십시오.

0. 핵심 원칙

  • 필수 문서 6종(AGENTS.md, BACKLOG.md, CHANGELOG.md, README.md, SECURITY.md, SOLUTION.md) 은 루트에 반드시 존재, 누락 시 작업 전 즉시 분석 후 생성
  • 모든 문서 및 커밋 메시지는 한국어 (코드/기술 용어 영문 허용)
  • PowerShell 실행 시 UTF-8 강제
  • 작업 시작 시 AGENTS.md 최우선 Read, 변경 발생 시 실행 기록/규칙 즉시 Append
  • git push 전 필수 문서 6종 최신화: 변경 사항을 해당 문서에 반영 (CHANGELOG.md 새 버전 기록, AGENTS.md 실행 기록 Append 등) 후 push

1. 초기화

  • 최초 실행 판단: 루트에 AGENTS.md 또는 BACKLOG.md 없으면 → 전체 분석 → 6종 일괄 생성
  • /init-deep (또는 /init) 권장: 아키텍처/코드베이스/기술스택 분석 → 6종 생성 + AGENTS.md 상세 기록
  • graphify 설치·그래프 구축: uv tool install --from graphifyy (uv 없으면 pip install graphifyy) → graphify-out/graph.json 없으면 초기 빌드 (graphify-out/ 에 graph.json, GRAPH_REPORT.md, graph.html 생성). 초기 빌드·갱신 모두 graphify skill 이나 에이전트 경유 금지, CLI 명령 직접 실행으로 빠르게 처리

2. 루트 디렉터리 거버넌스

  • 루트엔 6종 .md 만 허용, 그 외 .md 는 예외 없이 docs/ 로 이동
  • 6종 누락 시 3장 양식으로 즉시 생성

3. 파일별 역할 및 양식 (필수 섹션)

3.1 AGENTS.md — 에이전트 지식·컨텍스트 (지속 업데이트)

역할 1줄 + 필수 섹션: # 프로젝트 요약(1-2문장) / ## 빌드/테스트 방법(실행 명령) / ## 에이전트 행동 지침(핵심 규칙 요약) / ## 서브시스템 구조 / ## 실행 기록(날짜별 Append) 업데이트: 패키지 추가·아키텍처 변경·버그 수정 방식 파악 시 즉시 기록. 코드베이스 검색 시 graphify-out/ 존재하면 graphify query "<질문>" 으로 그래프 탐색, 코드 수정 후 graphify --update 로 그래프 동기화 → AGENTS.md 실행 기록 갱신. graphify 갱신은 skill 이나 에이전트를 통하지 말고 graphify --update CLI 명령 직접 실행 (빠른 동작 보장)

3.2 BACKLOG.md — 할 일 관리

역할 1줄 + 필수 포맷: # 백로그 / ## 높음 (H) 아래 - [ ] [H1] 설명 / ## 중간 (M) 아래 - [ ] [M1] 설명 / ## 낮음 (L) 아래 - [ ] [L1] 설명 규칙: 라벨 H/M/L+순번, 완료 시 [x] 표시 후 항목 삭제 (완료된 작업은 BACKLOG.md 에 남기지 않음)

3.3 CHANGELOG.md — 버전·변경사항 추적

역할 1줄 + 필수 포맷: # 변경 이력 / ## [v0.1.0] - <실제 날짜 YYYY-MM-DD> / ### 추가 / ### 변경 / ### 수정 / ### 제거 (해당 항목만) 규칙: 최초 생성 시 v0.1.0 + 실제 날짜 필수 (자리표시자 금지). 시맨틱 버저닝 MAJOR.MINOR.PATCH (파괴적=MAJOR, 기능=MINOR, 수정=PATCH), 변경 시 최상단에 새 버전

3.4 README.md — 프로젝트 소개

역할 1줄 + 필수 섹션: # 프로젝트명(한 줄 소개) / ## 시작하기 / ## 주요 기능 업데이트: 주요 기능·사용법 변경 시 즉시 갱신

3.5 SECURITY.md — 보안·인증·인가

역할 1줄 + 필수 섹션: # 보안 정책 / ## 인증/인가 / ## 비밀 관리 / ## 취약점 보고 / ## 코드 작성 시 보안 규칙 인증/인가 규칙: 프로젝트에서 사용 중인 인증 방식(Basic Auth, JWT, API Key 등) 분석 → 발견 시 ① 방식 설명 ② 실제 curl 예시(해당 인증 헤더 형식)를 ## 인증/인가 에 기록. 예: curl -u 사용자:비밀번호 (Basic) / curl -H "Authorization: Bearer <토큰>" (JWT) / curl -H "X-API-Key: <키>" (API Key). 실제 토큰/키 값 하드코딩 금지 — 자리표시자 필수 업데이트: 인증·보안 정책 변경 시 즉시 갱신

3.6 SOLUTION.md — 문제 해결 지식 베이스

역할 1줄 + 필수 포맷: # 문제 해결 지식 / ## [주제] / ### 증상 / ### 원인 / ### 해결 / ### 재발 방지 규칙: 다른 .md 의 문제 해결 내용 SOLUTION.md 로 이관·통합