28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# 프로젝트 AI / 문서 규칙
|
|
|
|
이 문서는 AI 에이전트가 이 저장소에서 작업할 때 참고하는 규칙과 문서 관리 원칙을 간결하게 정리합니다. 실제 작업 시 우선 적용 대상은 루트 `AGENTS.md`입니다.
|
|
|
|
## 기본 응답 원칙
|
|
- 모든 대화와 문서는 한국어로 작성한다.
|
|
- 코드 주석은 JSDoc 형식으로 작성한다.
|
|
- 답변은 짧고 명확하게 작성한다.
|
|
- 추측성 답변 금지.
|
|
- 불확실한 내용은 불확실하다고 명시한다.
|
|
|
|
## Git / 버전 규칙
|
|
- 커밋 메시지는 한국어로 작성한다.
|
|
- 버전이 올라가는 작업은 `docs/update.md`에 먼저 기록한다.
|
|
- 원격 푸시 전 민감 정보(실명, 이메일, 비밀번호, 로컬 경로)가 포함되지 않았는지 확인한다.
|
|
|
|
## 문서 자동 관리
|
|
- 작업 후 반드시 `docs/update.md`, `docs/todo.md`, `docs/spec.md`, `docs/history.md`, `docs/map.md`, `docs/convention.md`를 확인하고 필요한 내용을 반영한다.
|
|
- `docs/update.md`는 수행 작업을 기록한다.
|
|
- `docs/history.md`는 설계 결정 이유를 기록한다.
|
|
- `docs/todo.md`는 남은 작업을 정리한다.
|
|
- `docs/spec.md`는 구현·API·데이터 구조를 최신화한다.
|
|
- `docs/map.md`는 파일-화면/기능 매핑을 최신화한다.
|
|
|
|
## 실행 지침
|
|
- 수정 전에 관련 `docs/` 문서를 먼저 확인한다.
|
|
- 작업 완료 후 문서 반영 누락이 없도록 확인한다.
|