38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# 프로젝트 AI 가이드라인 및 문서화 규칙
|
|
|
|
## 🌐 기본 응답 원칙
|
|
- 모든 대화와 문서는 **한국어**로 작성한다.
|
|
- 코드 내 주석은 반드시 **JSDoc 형식**을 사용한다.
|
|
|
|
## 🧾 Git 및 버전 관리 규칙
|
|
- Git 작성자 정보는 프로젝트 기준 계정으로 통일한다.
|
|
- Git 커밋 메시지는 반드시 **한국어**로 작성한다.
|
|
- 버전이 올라가는 작업은 `docs/update.md`에 먼저 반영하고, 같은 버전명을 Git 태그에도 맞춘다.
|
|
- 원격 저장소에 푸시하기 전, 민감 정보(실명, 개인 이메일, 비밀키, 로컬 경로)가 포함되지 않았는지 확인한다.
|
|
|
|
## 📂 문서 자동 관리 규칙
|
|
모든 작업 수행 후, AI는 관련 내용을 아래 지정된 파일에 즉시 반영해야 한다.
|
|
|
|
1. **작업 이력 (docs/update.md)**
|
|
- 수행한 작업 내용을 상세히 기록한다.
|
|
- 당일 업데이트라도 수정 시마다 버전을 갱신하여 하나의 파일에 누적 관리한다. (별도 파일 생성 금지)
|
|
|
|
2. **할 일 및 이슈 (docs/todo.md)**
|
|
- 현재 직면한 문제점과 다음에 이어서 진행할 작업 목록을 정리한다.
|
|
|
|
3. **기술 명세 (docs/spec.md)**
|
|
- API 명세, 기획 내용, 데이터베이스 스키마 구조를 최신 상태로 유지한다.
|
|
|
|
4. **코딩 컨벤션 (docs/convention.md)**
|
|
- 프로젝트 전용 코딩 스타일 및 네이밍 규칙(Variable, Function, Class 등)을 정의하고 준수한다.
|
|
|
|
5. **의사결정 이력 (docs/history.md)**
|
|
- 주요 설계 결정 사항 및 시스템 아키텍처 변경 이력을 기록한다.
|
|
|
|
6. **파일-화면 매핑 가이드 (docs/map.md)**
|
|
- 연결성 기록: 특정 파일(Ex: Login.jsx)이 브라우저 화면의 어느 경로(/login)와 어느 기능(로그인 버튼 등)을 담당하는지 초보자 관점에서 기록한다.
|
|
|
|
## ⚠️ 실행 지침
|
|
- 새로운 코드를 작성하거나 수정하기 전, 반드시 `docs/` 내 관련 문서들을 먼저 참조한다.
|
|
- 작업 완료 후 위 문서들의 업데이트가 누락되지 않도록 확인한다.
|