Skip to content

gl0bal01/claude-e2e-workflow

Claude E2E Workflow

npm version CI License: MIT Node.js Claude Code PRs Welcome

Prompt-based workflow system for Claude Code - Not executable code, but structured prompts that teach Claude how to deliver features end-to-end.

If your project fits in one Claude session, you don't need this.

Built for developers who use Claude Code on real projects and need:

  • Consistent delivery: A 6-step pipeline from review to PR, every time
  • Persistent memory: Context that survives across sessions and refactoring
  • Tracked decisions: Architecture choices linked to actual code
  • Quality gates: Automated checks before every PR

What This Is (And What It's Not)

This Is

  • Structured prompts (skills) that Claude Code loads into context
  • Workflow templates that guide Claude through a 6-step delivery process
  • Memory schemas that define how to store/retrieve context efficiently
  • Best practices documentation for black-box architecture

This Is Not

  • Executable code or a CLI tool
  • A plugin that adds new commands to Claude Code
  • An autonomous agent that runs independently

How It Works

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  YOU: "Use the workflow skill to add authentication"            β”‚
β”‚                           ↓                                     β”‚
β”‚  CLAUDE CODE: Loads skills/workflow.md into context             β”‚
β”‚                           ↓                                     β”‚
β”‚  CLAUDE: Follows the 6-step protocol defined in the skill       β”‚
β”‚                           ↓                                     β”‚
β”‚  RESULT: Structured delivery with memory and traceability       β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Requirements

Requirement Version Notes
Claude Code Latest CLI tool from Anthropic
Git 2.0+ For commit tracking
Node.js 18+ Optional: for validation scripts

Quick Start

1. Install

npm (Recommended)

# Install globally
npm install -g claude-e2e-workflow

# Or in your project
npm install claude-e2e-workflow

After installation, copy skills to your Claude Code directory manually or use the git method below.

Linux / macOS

# Clone
git clone https://github.com/gl0bal01/claude-e2e-workflow.git
cd claude-e2e-workflow

# Run installer
./scripts/install.sh

# Or with options
./scripts/install.sh --help      # Show usage
./scripts/install.sh --dry-run   # Preview changes
./scripts/install.sh --verbose   # Detailed output

Windows (PowerShell)

# Clone
git clone https://github.com/gl0bal01/claude-e2e-workflow.git
cd claude-e2e-workflow

# Run installer
.\scripts\install.ps1

# Or with options
.\scripts\install.ps1 -Help      # Show usage
.\scripts\install.ps1 -DryRun    # Preview changes
.\scripts\install.ps1 -Verbose   # Detailed output

Manual Install (Any Platform)

# Copy skills and commands to Claude's directory
# Linux/macOS: ~/.claude/
# Windows: %USERPROFILE%\.claude\

cp -r skills/* ~/.claude/skills/
cp -r commands/* ~/.claude/commands/

2. Verify Installation

# Linux / macOS
./scripts/verify.sh

# Windows (PowerShell)
.\scripts\verify.ps1

3. Use in Claude Code

You: I want to add user authentication. Use the e2e workflow skill.

Claude: I'll follow the 6-step E2E workflow:
        Step 1: Review - Let me analyze your codebase...
        [continues through all 6 steps]

See QUICKSTART.md for detailed guide.


Plugin Marketplace

Install directly from the Claude Code plugin marketplace:

# Add from marketplace
claude plugin marketplace add gl0bal01/claude-e2e-workflow

# Or install from local directory
claude plugin install ./path/to/claude-e2e-workflow

# Enable the plugin
claude plugin enable claude-e2e-workflow

Plugin Structure

.claude-plugin/
└── marketplace.json    # Plugin metadata for marketplace discovery

skills/
└── claude-e2e-workflow/
    β”œβ”€β”€ skill.json      # Skill registry with variants
    β”œβ”€β”€ memory.md       # Memory management skill
    β”œβ”€β”€ retrieve.md     # Context retrieval skill
    β”œβ”€β”€ refactor.md     # Black-box refactoring skill
    β”œβ”€β”€ plan.md         # Architecture planning skill
    β”œβ”€β”€ debug.md        # Debugging skill
    └── security.md     # Security audit skill

Available Skills

Skill Description Tokens
memory Create, verify, repair anchors. Manage decisions, tasks, patterns. 1800
retrieve Load context by task/module/symbol/tags. Token-efficient. 1500
refactor Analyze and refactor into black-box components. 750
plan Design strategic architecture with module boundaries. 1140
debug Systematic debugging with boundary analysis. 1450
security OWASP Top 10, secrets detection, auth patterns. 2100

See docs/PLUGIN-MARKETPLACE.md for full plugin documentation.


The 6-Step Pipeline

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”   β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ REVIEW β”‚ β†’ β”‚  PLAN  β”‚ β†’ β”‚ PATCH  β”‚ β†’ β”‚ VERIFY β”‚ β†’ β”‚   PR   β”‚ β†’ β”‚ MEMORY β”‚
β”‚  read  β”‚   β”‚ design β”‚   β”‚ impl   β”‚   β”‚ gates  β”‚   β”‚ summaryβ”‚   β”‚ save   β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜   β””β”€β”€β”€β”€β”€β”€β”€β”€β”˜
     β”‚            β”‚            β”‚            β”‚            β”‚            β”‚
     β”‚       [approval]        β”‚       [on fail]        β”‚            β”‚
     β”‚            β”‚            β”‚         fix            β”‚            β”‚
     β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                    β”‚
                         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
                         β”‚    MEMORY LAYER     β”‚
                         β”‚  anchors β”‚ tasks    β”‚
                         β”‚  decisions β”‚ patternsβ”‚
                         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
Step Purpose Output
Review Understand codebase without changes Architecture report with file:line
Plan Design black-box modules Migration plan (requires approval)
Patch Implement one module at a time Commits with anchors
Verify Run quality gates Pass/fail report
PR Human-readable summary PR description
Memory Save context for next session Updated memory files

Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                           CLAUDE CODE                                    β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
β”‚  β”‚                         SKILLS LAYER                                β”‚ β”‚
β”‚  β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚
β”‚  β”‚  β”‚ memory   β”‚ β”‚ retrieve β”‚ β”‚ refactor β”‚ β”‚   plan   β”‚ β”‚  debug   β”‚ β”‚ β”‚
β”‚  β”‚  β”‚ 1800 tok β”‚ β”‚ 1500 tok β”‚ β”‚  750 tok β”‚ β”‚ 1140 tok β”‚ β”‚ 1450 tok β”‚ β”‚ β”‚
β”‚  β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚
β”‚  β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”                                                      β”‚ β”‚
β”‚  β”‚  β”‚ security β”‚  ← OWASP Top 10, secrets detection, auth patterns    β”‚ β”‚
β”‚  β”‚  β”‚ 2100 tok β”‚                                                      β”‚ β”‚
β”‚  β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                                                      β”‚ β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
β”‚  β”‚                         AGENTS LAYER                                β”‚ β”‚
β”‚  β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”                                               β”‚ β”‚
β”‚  β”‚  β”‚    workflow     β”‚ ─── orchestrates ───────────────────────┐     β”‚ β”‚
β”‚  β”‚  β”‚  orchestrator   β”‚                                         β”‚     β”‚ β”‚
β”‚  β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜                                         β–Ό     β”‚ β”‚
β”‚  β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚ β”‚
β”‚  β”‚  β”‚ reviewer β”‚ β”‚ planner  β”‚ β”‚implement β”‚ β”‚ verifier β”‚ β”‚ debugger β”‚ β”‚ β”‚
β”‚  β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚ β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                                    β”‚
                                    β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                         YOUR PROJECT                                     β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”‚
β”‚  β”‚ .claude/memory/                                                  β”‚    β”‚
β”‚  β”‚   anchors.jsonl   β†’ Code references with drift protection       β”‚    β”‚
β”‚  β”‚   decisions.jsonl β†’ Architecture Decision Records (ADR)         β”‚    β”‚
β”‚  β”‚   tasks.jsonl     β†’ Task tracking with dependencies             β”‚    β”‚
β”‚  β”‚   patterns.jsonl  β†’ Learned codebase conventions                β”‚    β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β”‚
β”‚  β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”    β”‚
β”‚  β”‚ CLAUDE.md β†’ Project-specific configuration (source of truth)    β”‚    β”‚
β”‚  β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜    β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

Memory System

Anchor Schema

Anchors are drift-resistant code references that survive refactoring.

{
  "anchor_id": "anc_a1b2c3d4",
  "commit": "abc123def",
  "path": "src/auth/service.ts",
  "start_line": 45,
  "end_line": 92,
  "symbol": "AuthService.login",
  "symbol_type": "method",
  "snippet_hash": "sha256:8f14e45f...",
  "context_hash": "sha256:2c26b46b...",
  "summary": "Validates credentials and creates JWT token",
  "tags": ["auth", "critical-path", "jwt"],
  "status": "valid",
  "created_at": "2025-01-15T10:30:00Z",
  "last_verified": "2025-01-15T10:30:00Z"
}

Drift Protection

When code moves, anchors find it:

Strategy How It Works Reliability
Line number Direct lookup Fast but fragile
Symbol lookup Find by function/class name High
Snippet hash Match exact content Exact
Context hash Match surrounding lines Fuzzy
Git blame Track code movement Historical

Validation

All memory files are validated against JSON Schemas with built-in secret detection:

# Validate all memory files (includes secret scanning)
node scripts/validate-memory.js .claude/memory/

# Validate single file
node scripts/validate-memory.js .claude/memory/anchors.jsonl

# Skip secret detection
node scripts/validate-memory.js .claude/memory/ --no-secrets

Version Consistency

Keep versions synchronized across all config files:

# Check version consistency
npm run version:check

# Sync all versions to match package.json
npm run version:sync

Token Budget

Claude has limited context. We optimize for it:

Context Type Tokens Priority When Loaded
Active task 500 Critical Always
Current module interface 300 Critical Always
Related interfaces 200 High On demand
Recent decisions 200 Medium When relevant
Hot paths 100 High Always
Work buffer 1700 - Reserved
Total budget 3000 - -

Note: These values are tuned for Claude Opus. Adjust for other models.


Quality Gates

Gate Tool Blocking Purpose
lint ESLint/Ruff/etc Yes Code style
typecheck tsc/mypy/etc Yes Type safety
unit_tests Jest/pytest/etc Yes Component tests
contract_tests Custom Yes Interface compliance
boundary_check Custom Yes No forbidden imports
e2e_smoke Playwright/etc No Critical path
security_scan npm audit/etc No Vulnerabilities

Project Structure

claude-e2e-workflow/
β”œβ”€β”€ .claude-plugin/              # Plugin marketplace configuration
β”‚   └── marketplace.json         # Plugin metadata for discovery
β”‚
β”œβ”€β”€ agents/                      # Agent definitions
β”‚   β”œβ”€β”€ workflow-orchestrator.md # Main coordinator
β”‚   β”œβ”€β”€ arch-reviewer.md         # Read-only analysis
β”‚   β”œβ”€β”€ arch-planner.md          # Architecture design
β”‚   β”œβ”€β”€ arch-implementer.md      # Code changes
β”‚   β”œβ”€β”€ arch-verifier.md         # Quality gates
β”‚   β”œβ”€β”€ arch-debugger.md         # Bug isolation
β”‚   └── agent.json               # Agent registry
β”‚
β”œβ”€β”€ skills/                      # Skill definitions
β”‚   └── claude-e2e-workflow/     # Plugin-compatible skill package
β”‚       β”œβ”€β”€ skill.json           # Skill registry with variants
β”‚       β”œβ”€β”€ memory.md            # Memory operations
β”‚       β”œβ”€β”€ retrieve.md          # Context loading
β”‚       β”œβ”€β”€ refactor.md          # Black-box refactoring
β”‚       β”œβ”€β”€ plan.md              # Architecture planning
β”‚       β”œβ”€β”€ debug.md             # Debugging
β”‚       β”œβ”€β”€ security.md          # Security audit
β”‚       └── SKILL.md             # Skill documentation
β”‚
β”œβ”€β”€ commands/                    # Command templates
β”‚   β”œβ”€β”€ workflow.md
β”‚   β”œβ”€β”€ review.md
β”‚   β”œβ”€β”€ memory.md
β”‚   └── arch-*.md
β”‚
β”œβ”€β”€ schemas/                     # JSON Schemas for validation
β”‚   β”œβ”€β”€ anchor.schema.json
β”‚   β”œβ”€β”€ decision.schema.json
β”‚   β”œβ”€β”€ task.schema.json
β”‚   └── pattern.schema.json
β”‚
β”œβ”€β”€ scripts/                     # Utility scripts
β”‚   β”œβ”€β”€ install.sh               # Installation
β”‚   β”œβ”€β”€ verify.sh                # Verification
β”‚   β”œβ”€β”€ validate-memory.js       # Schema + secret validation
β”‚   └── sync-version.js          # Version consistency
β”‚
β”œβ”€β”€ examples/                    # Working examples
β”‚   └── todo-app/
β”‚       β”œβ”€β”€ before/              # Messy code
β”‚       β”œβ”€β”€ after/               # Black-box version
β”‚       └── README.md            # Walkthrough
β”‚
β”œβ”€β”€ templates/
β”‚   └── CLAUDE.md                # Project template
β”‚
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ E2E-WORKFLOW.md          # Full documentation
β”‚   β”œβ”€β”€ QUICKSTART.md            # 5-minute guide
β”‚   β”œβ”€β”€ ARCHITECTURE.md          # Design decisions
β”‚   β”œβ”€β”€ PLUGIN-MARKETPLACE.md    # Plugin installation guide
β”‚   β”œβ”€β”€ QUALITY-GATES.md         # Pass/fail criteria
β”‚   β”œβ”€β”€ DRIFT-DETECTION.md       # Anchor repair strategies
β”‚   β”œβ”€β”€ AGENT-EXAMPLES.md        # Input/output examples
β”‚   β”œβ”€β”€ DEPENDENCIES.md          # Dependency audit
β”‚   β”œβ”€β”€ CONFIGURATION.md         # Hardcoded values reference
β”‚   └── PUBLISHING.md            # npm publishing guide
β”‚
β”œβ”€β”€ tests/                       # Validation tests
β”‚   └── schemas.test.js
β”‚
β”œβ”€β”€ .github/
β”‚   β”œβ”€β”€ ISSUE_TEMPLATE/
β”‚   β”‚   β”œβ”€β”€ bug_report.md
β”‚   β”‚   └── feature_request.md
β”‚   └── PULL_REQUEST_TEMPLATE.md
β”‚
β”œβ”€β”€ README.md                    # This file
β”œβ”€β”€ CONTRIBUTING.md              # How to contribute
β”œβ”€β”€ CHANGELOG.md                 # Version history
β”œβ”€β”€ SECURITY.md                  # Security policy
β”œβ”€β”€ CODE_OF_CONDUCT.md           # Community standards
└── LICENSE                      # MIT

Examples

See examples/todo-app/ for a complete before/after transformation.

Before (Messy)

// One file does everything
class TodoApp {
  db: any;
  mailer: any;

  async createTodo(data: any) {
    // validation mixed with business logic
    // direct DB calls
    // email sending inline
    // no error handling
  }
}

After (Black-Box)

// Clean separation
interface ITodoService {
  create(data: CreateTodoDTO): Promise<Result<Todo, TodoError>>;
}

class TodoService implements ITodoService {
  constructor(
    private repo: ITodoRepository,
    private events: IEventBus
  ) {}

  async create(data: CreateTodoDTO): Promise<Result<Todo, TodoError>> {
    // Single responsibility
    // Dependency injection
    // Typed errors
    // Testable
  }
}

Contributing

We welcome contributions! See CONTRIBUTING.md for:

  • How to report bugs
  • How to suggest features
  • Code style guidelines
  • Pull request process

Changelog

See CHANGELOG.md for version history.

Current version: 1.0.0


Security

See SECURITY.md for:

  • Supported versions
  • How to report vulnerabilities
  • Security best practices

License

MIT - See LICENSE


Acknowledgments


Links