requirements-framework-development

# Requirements Framework Development

Guide for developing, fixing, and maintaining the **Claude Code Requirements Framework** with proper sync workflow.

**Repository**: `~/Tools/claude-requirements-framework` (git-controlled source of truth)
**Deployed**: `~/.claude/hooks/` (active runtime)
**Remote**: https://github.com/HarmAalbers/claude-requirements-framework.git

## Core Concept: Two-Location Architecture

The framework lives in TWO places that must stay synchronized:

| Location | Purpose | When Changes Take Effect |
|----------|---------|--------------------------|
| **Repository** | Git source of truth | After `./sync.sh deploy` |
| **Deployed** | Active runtime | Immediately |

**→ Full sync details**: See `references/sync-workflow-details.md`

## sync.sh - The Essential Tool

```bash
cd ~/Tools/claude-requirements-framework

./sync.sh status  # Check sync (ALWAYS run first)
./sync.sh deploy  # Repository → ~/.claude/hooks
./sync.sh diff    # Show differences
```

### Status Symbols

| Symbol | Meaning | Action |
|--------|---------|--------|
| `✓` | In sync | None needed |
| `↑` | Out of sync | Run `./sync.sh deploy` |
| `⚠` | Not deployed | Run `./sync.sh deploy` |
| `✗` | Missing in repo | Copy or delete |

## Development Workflows

### Workflow A: Standard Development

**Pattern**: Edit in repo → Deploy → Test → Commit

```bash
cd ~/Tools/claude-requirements-framework

# 1. Edit in repository
vim hooks/lib/requirements.py

# 2. Deploy
./sync.sh deploy

# 3. Test
python3 ~/.claude/hooks/test_requirements.py

# 4. Commit
git add . && git commit -m "feat: Add feature" && git push
```

### Workflow B: Emergency Fix

**Pattern**: Fix in deployed → Test → Copy back → Commit

```bash
# 1. Fix directly (immediate effect)
vim ~/.claude/hooks/check-requirements.py

# 2. Test immediately
python3 ~/.claude/hooks/test_requirements.py

# 3. Copy to repo
cd ~/Tools/claude-requirements-framework
cp ~/.claude/hooks/check-requirements.py hooks/

# 4. Deploy and commit
.