Skip to content

Commit 4100f50

Browse files
snooclaude
andcommitted
docs: Update READMEs with v3.2.0 features
- Add Hooks auto-reminder section (English/Korean) - Add context optimization section (subfolder CLAUDE.md, Do Not Touch) - Add multi-repo work tracking section (cross-repo tags) - Update feature table with Hooks - Update project structure to show settings.json Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 3e66b06 commit 4100f50

File tree

2 files changed

+232
-2
lines changed

2 files changed

+232
-2
lines changed

README.ko.md

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,119 @@ codesyncer watch
9898

9999
---
100100

101+
## 🪝 Hooks: 자동 리마인드 시스템 (v3.2.0 신규)
102+
103+
**문제**: 긴 코딩 세션에서 AI가 태그 규칙을 잊을 수 있습니다.
104+
105+
**해결**: Hooks가 AI 응답 완료 전에 자동으로 태그 추가 여부를 리마인드합니다.
106+
107+
### 작동 방식
108+
109+
`codesyncer init` 실행 시 다음과 같이 묻습니다:
110+
111+
```
112+
🪝 Hooks 설정 (권장)
113+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
114+
Hooks란?
115+
세션이 길어지면 AI가 태그 규칙을 까먹을 수 있습니다.
116+
Hooks를 설정하면 AI가 응답 완료 전에
117+
자동으로 "태그 붙였어?" 확인합니다.
118+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
119+
120+
? Hooks를 설정할까요? (권장) (Y/n)
121+
```
122+
123+
"Y" 선택 시 `.claude/settings.json` 생성:
124+
125+
```json
126+
{
127+
"hooks": {
128+
"Stop": [{
129+
"hooks": [{
130+
"type": "prompt",
131+
"prompt": "작업 완료 전 CodeSyncer 체크: 1) 추론→@codesyncer-inference 태그? 2) 결정→@codesyncer-decision 태그? 3) 💰결제/🔐보안→사용자에게 물었나? 빠진 태그가 있으면 지금 추가하세요."
132+
}]
133+
}]
134+
}
135+
}
136+
```
137+
138+
### Hook 이벤트
139+
140+
| 이벤트 | 트리거 시점 | 목적 |
141+
|--------|------------|------|
142+
| **Stop** | AI 응답 완료 전 | 태그 추가 리마인드 |
143+
| **PreCompact** | 컨텍스트 압축 전 | 핵심 규칙 메모리 유지 |
144+
145+
### Hooks 관리
146+
147+
- **활성화**: AI에게 "CodeSyncer Hooks 설정해줘" 말하기
148+
- **비활성화**: `.claude/settings.json` 삭제
149+
- **커스터마이징**: `.claude/settings.json` 직접 편집
150+
151+
---
152+
153+
## 📂 대규모 프로젝트 컨텍스트 최적화 (v3.2.0 신규)
154+
155+
코드베이스가 커지면 AI가 헷갈릴 수 있습니다. v3.2.0에서 AI 집중력을 유지하는 기능이 추가되었습니다.
156+
157+
### 서브폴더별 CLAUDE.md
158+
159+
프로젝트가 커지면 특정 폴더에 CLAUDE.md를 추가하세요:
160+
161+
```
162+
project/
163+
├── CLAUDE.md # 전체 규칙
164+
├── src/
165+
│ ├── payment/
166+
│ │ └── CLAUDE.md # 결제 관련 규칙 + 태그 리마인드
167+
│ └── auth/
168+
│ └── CLAUDE.md # 인증 관련 규칙
169+
```
170+
171+
AI가 해당 폴더에 진입하면 자동으로 관련 CLAUDE.md를 읽습니다.
172+
173+
**템플릿 포함**: `src/templates/subfolder-claude.md`
174+
175+
### Do Not Touch 영역
176+
177+
AI가 절대 수정하면 안 되는 폴더 정의:
178+
179+
```markdown
180+
## 🚫 Do Not Touch
181+
- `src/generated/` - 자동 생성 파일, 수정 금지
182+
- `src/legacy/` - 마이그레이션 전까지 수정 금지
183+
- `.env*` - 환경 변수, 직접 수정 금지
184+
```
185+
186+
이로써 AI가 실수로 중요하거나 자동 생성된 코드를 수정하는 것을 방지합니다.
187+
188+
---
189+
190+
## 🔗 멀티 레포 작업 추적 (v3.2.0 신규)
191+
192+
### Git 브랜치 = 작업 ID
193+
194+
브랜치명을 작업 ID로 사용하세요:
195+
- `feature/AUTH-001-login`
196+
- `fix/PAY-002-webhook`
197+
198+
### 크로스 레포 태그
199+
200+
여러 레포에 걸친 작업은 같은 태그 사용:
201+
202+
```typescript
203+
// frontend 레포
204+
// @codesyncer-work:AUTH-001 로그인 폼
205+
206+
// backend 레포
207+
// @codesyncer-work:AUTH-001 로그인 API
208+
```
209+
210+
레포 전체 검색: `grep -r "@codesyncer-work:AUTH-001" ../`
211+
212+
---
213+
101214
## ✨ 전체 기능 목록
102215

103216
| 기능 | 설명 |
@@ -106,6 +219,7 @@ codesyncer watch
106219
| 🔄 **Watch 모드** | 실시간 모니터링, 태그 없는 변경 경고, DECISIONS.md 자동 동기화 |
107220
|**Validate** | 태그 커버리지 확인, 누락된 문서 찾기, 수정 제안 |
108221
| 🤝 **자동 일시정지** | 결제/보안/인증 키워드 감지 → 코딩 전 확인 |
222+
| 🪝 **Hooks** | 자동 리마인드 시스템 - 긴 세션에서도 AI가 규칙을 잊지 않음 (v3.2.0 신규) |
109223
| 📦 **모노레포** | Turborepo, pnpm, Nx, Lerna, npm/yarn workspaces 자동 감지 |
110224
| 🌐 **다국어** | 한글/영문 완벽 지원 |
111225
| 🔒 **보안** | 경로 탐색 방지 및 입력 검증 |
@@ -636,7 +750,8 @@ my-project/
636750
├── CLAUDE.md # 코딩 가이드라인
637751
├── COMMENT_GUIDE.md # 태그 사용 가이드
638752
├── ARCHITECTURE.md # 프로젝트 구조
639-
└── DECISIONS.md # 의사결정 기록
753+
├── DECISIONS.md # 의사결정 기록
754+
└── settings.json # Hooks 설정 (v3.2.0+, 선택)
640755
```
641756

642757
### 멀티 레포지토리 모드

README.md

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,119 @@ codesyncer watch
9898

9999
---
100100

101+
## 🪝 Hooks: Auto-Reminder System (NEW in v3.2.0)
102+
103+
**Problem**: In long coding sessions, AI might forget the tagging rules.
104+
105+
**Solution**: Hooks automatically remind AI to add tags before completing each response.
106+
107+
### How It Works
108+
109+
When you run `codesyncer init`, you'll be asked:
110+
111+
```
112+
🪝 Hooks Setup (Recommended)
113+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
114+
What are Hooks?
115+
In long sessions, AI might forget tagging rules.
116+
Hooks automatically remind AI to check:
117+
"Did you add the tags?" before each response.
118+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
119+
120+
? Set up Hooks? (Recommended) (Y/n)
121+
```
122+
123+
If you choose "Yes", CodeSyncer generates `.claude/settings.json`:
124+
125+
```json
126+
{
127+
"hooks": {
128+
"Stop": [{
129+
"hooks": [{
130+
"type": "prompt",
131+
"prompt": "Before completing: CodeSyncer check - 1) Inference → @codesyncer-inference tag? 2) Decision → @codesyncer-decision tag? 3) 💰Payment/🔐Security → Did you ask the user? Add any missing tags now."
132+
}]
133+
}]
134+
}
135+
}
136+
```
137+
138+
### Hook Events
139+
140+
| Event | When It Triggers | Purpose |
141+
|-------|------------------|---------|
142+
| **Stop** | Before AI completes response | Remind to add tags |
143+
| **PreCompact** | Before context compaction | Preserve key rules in memory |
144+
145+
### Managing Hooks
146+
147+
- **Enable**: Say "Set up CodeSyncer Hooks" to your AI
148+
- **Disable**: Delete `.claude/settings.json`
149+
- **Customize**: Edit `.claude/settings.json` directly
150+
151+
---
152+
153+
## 📂 Context Optimization for Large Projects (NEW in v3.2.0)
154+
155+
As your codebase grows, AI can get confused. v3.2.0 introduces features to keep AI focused.
156+
157+
### Subfolder CLAUDE.md
158+
159+
When your project gets large, add CLAUDE.md files to specific folders:
160+
161+
```
162+
project/
163+
├── CLAUDE.md # Global rules
164+
├── src/
165+
│ ├── payment/
166+
│ │ └── CLAUDE.md # Payment-specific rules + tag reminder
167+
│ └── auth/
168+
│ └── CLAUDE.md # Auth-specific rules
169+
```
170+
171+
AI automatically reads the relevant CLAUDE.md when entering a folder.
172+
173+
**Template included**: `src/templates/subfolder-claude.md`
174+
175+
### Do Not Touch Zones
176+
177+
Define folders that AI should never modify:
178+
179+
```markdown
180+
## 🚫 Do Not Touch
181+
- `src/generated/` - Auto-generated files, do not modify
182+
- `src/legacy/` - Do not modify until migration
183+
- `.env*` - Environment variables, do not edit directly
184+
```
185+
186+
This prevents AI from accidentally modifying critical or auto-generated code.
187+
188+
---
189+
190+
## 🔗 Multi-Repo Work Tracking (NEW in v3.2.0)
191+
192+
### Git Branch = Work ID
193+
194+
Use branch names as work identifiers:
195+
- `feature/AUTH-001-login`
196+
- `fix/PAY-002-webhook`
197+
198+
### Cross-Repo Tags
199+
200+
For work spanning multiple repos, use the same tag:
201+
202+
```typescript
203+
// frontend repo
204+
// @codesyncer-work:AUTH-001 Login form
205+
206+
// backend repo
207+
// @codesyncer-work:AUTH-001 Login API
208+
```
209+
210+
Search across repos: `grep -r "@codesyncer-work:AUTH-001" ../`
211+
212+
---
213+
101214
## ✨ Full Feature List
102215

103216
| Feature | Description |
@@ -106,6 +219,7 @@ codesyncer watch
106219
| 🔄 **Watch Mode** | Real-time monitoring, warns on untagged changes, auto-syncs to DECISIONS.md |
107220
|**Validate** | Check tag coverage, find missing documentation, get fix suggestions |
108221
| 🤝 **Auto-Pause** | Detects payment/security/auth keywords → asks before coding |
222+
| 🪝 **Hooks** | Auto-reminder system - AI never forgets rules even in long sessions (NEW v3.2.0) |
109223
| 📦 **Monorepo** | Auto-detects Turborepo, pnpm, Nx, Lerna, npm/yarn workspaces |
110224
| 🌐 **Multi-Language** | Full Korean and English support |
111225
| 🔒 **Security** | Path traversal protection and input validation |
@@ -636,7 +750,8 @@ my-project/
636750
├── CLAUDE.md # Coding guidelines
637751
├── COMMENT_GUIDE.md # Tag usage guide
638752
├── ARCHITECTURE.md # Project structure
639-
└── DECISIONS.md # Decision log
753+
├── DECISIONS.md # Decision log
754+
└── settings.json # Hooks config (v3.2.0+, optional)
640755
```
641756

642757
### Multi-Repository Mode

0 commit comments

Comments
 (0)