chore: .agents 워크플로우/레퍼런스/가이드 전체 추가 (.gitignore 규칙 제거)
This commit is contained in:
35
.agents/references/architecture.md
Normal file
35
.agents/references/architecture.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Architecture
|
||||
|
||||
> 이 프로젝트의 아키텍처를 설명하는 문서입니다.
|
||||
> AI 에이전트는 구현 전 이 문서를 반드시 확인합니다.
|
||||
|
||||
## 프로젝트 개요
|
||||
|
||||
<!-- 프로젝트의 목적과 핵심 기능을 간략히 서술 -->
|
||||
|
||||
(프로젝트 설명을 여기에 작성하세요)
|
||||
|
||||
## 디렉토리 구조
|
||||
|
||||
```
|
||||
project-root/
|
||||
├── src/ # 소스 코드
|
||||
├── tests/ # 테스트
|
||||
├── docs/ # 문서
|
||||
├── .agents/ # AI 에이전트 설정
|
||||
└── ...
|
||||
```
|
||||
|
||||
## 핵심 모듈
|
||||
|
||||
<!-- 각 모듈의 역할과 의존 관계를 설명 -->
|
||||
|
||||
| 모듈 | 역할 | 의존성 |
|
||||
|------|------|--------|
|
||||
| (모듈명) | (역할 설명) | (의존하는 모듈) |
|
||||
|
||||
## 데이터 흐름
|
||||
|
||||
<!-- 주요 데이터 흐름을 Mermaid 다이어그램이나 텍스트로 설명 -->
|
||||
|
||||
(데이터 흐름을 여기에 작성하세요)
|
||||
45
.agents/references/conventions.md
Normal file
45
.agents/references/conventions.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Coding Conventions
|
||||
|
||||
> AI 에이전트는 코드를 작성하기 전 이 컨벤션을 확인합니다.
|
||||
|
||||
## 네이밍
|
||||
|
||||
| 대상 | 규칙 | 예시 |
|
||||
|------|------|------|
|
||||
| 변수/함수 | camelCase | `getUserData()` |
|
||||
| 클래스 | PascalCase | `UserService` |
|
||||
| 상수 | UPPER_SNAKE_CASE | `MAX_RETRY_COUNT` |
|
||||
| 파일명 | kebab-case | `user-service.js` |
|
||||
| CSS 클래스 | kebab-case | `.nav-header` |
|
||||
|
||||
## 코드 스타일
|
||||
|
||||
- 들여쓰기: (2 spaces / 4 spaces / tab)
|
||||
- 세미콜론: (사용 / 미사용)
|
||||
- 따옴표: (single / double)
|
||||
- 줄바꿈: LF (Unix style)
|
||||
|
||||
## 커밋 메시지
|
||||
|
||||
```
|
||||
<type>(<scope>): <description>
|
||||
|
||||
type: feat|fix|refactor|test|docs|chore|ci|infra
|
||||
scope: (선택)
|
||||
```
|
||||
|
||||
**예시:**
|
||||
- `feat(server): add WebSocket reconnection logic`
|
||||
- `fix(frontend): resolve button overlap on mobile`
|
||||
- `docs: update API documentation`
|
||||
|
||||
## 주석
|
||||
|
||||
- 한국어/영어 혼용 가능
|
||||
- TODO 주석: `// TODO: 설명` 형식
|
||||
- 복잡한 로직에는 반드시 WHY(왜) 주석 추가
|
||||
|
||||
## 테스트
|
||||
|
||||
- 테스트 파일 위치: (예: `__tests__/` 또는 `*.test.js`)
|
||||
- 테스트 네이밍: `should [expected behavior] when [condition]`
|
||||
37
.agents/references/tech-stack.md
Normal file
37
.agents/references/tech-stack.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Tech Stack
|
||||
|
||||
> AI 에이전트는 구현 전 이 문서를 확인하여 올바른 기술/버전을 사용합니다.
|
||||
|
||||
## 언어 & 런타임
|
||||
|
||||
| 항목 | 버전 | 비고 |
|
||||
|------|------|------|
|
||||
| (예: Node.js) | (예: 20.x) | (설치 경로 등) |
|
||||
| (예: Python) | (예: 3.12) | (가상환경 경로 등) |
|
||||
|
||||
## 프레임워크
|
||||
|
||||
| 항목 | 버전 | 용도 |
|
||||
|------|------|------|
|
||||
| (예: Express) | (예: 4.18) | (서버) |
|
||||
| (예: React) | (예: 18.x) | (프론트엔드) |
|
||||
|
||||
## 패키지 관리
|
||||
|
||||
- 패키지 매니저: (npm / yarn / pnpm / pip 등)
|
||||
- Lock 파일: (package-lock.json / yarn.lock 등)
|
||||
|
||||
## 개발 도구
|
||||
|
||||
| 도구 | 명령어 |
|
||||
|------|--------|
|
||||
| 개발 서버 | (예: `cmd /c npm run dev`) |
|
||||
| 빌드 | (예: `cmd /c npm run build`) |
|
||||
| 테스트 | (예: `cmd /c npm test`) |
|
||||
| 린트 | (예: `cmd /c npm run lint`) |
|
||||
|
||||
## 환경 변수
|
||||
|
||||
| 변수명 | 용도 | 기본값 |
|
||||
|--------|------|--------|
|
||||
| (예: PORT) | (서버 포트) | (3000) |
|
||||
Reference in New Issue
Block a user