diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dda1e713..ec983b4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,8 +52,8 @@ Slash commands that invoke useful workflows: ```bash # 1. Fork and clone -gh repo fork affaan-m/everything-claude-code --clone -cd everything-claude-code +gh repo fork affaan-m/ECC --clone +cd ECC # 2. Create a branch git checkout -b feat/my-contribution @@ -499,7 +499,7 @@ How you tested this. ## Questions? -- **Issues:** [github.com/affaan-m/everything-claude-code/issues](https://github.com/affaan-m/everything-claude-code/issues) +- **Issues:** [github.com/affaan-m/ECC/issues](https://github.com/affaan-m/ECC/issues) - **X/Twitter:** [@affaanmustafa](https://x.com/affaanmustafa) --- diff --git a/EVALUATION.md b/EVALUATION.md deleted file mode 100644 index 929ddf66..00000000 --- a/EVALUATION.md +++ /dev/null @@ -1,122 +0,0 @@ -# Repo Evaluation vs Current Setup - -**Date:** 2026-03-21 -**Branch:** `claude/evaluate-repo-comparison-ASZ9Y` - ---- - -## Current Setup (`~/.claude/`) - -The active Claude Code installation is near-minimal: - -| Component | Current | -|-----------|---------| -| Agents | 0 | -| Skills | 0 installed | -| Commands | 0 | -| Hooks | 1 (Stop: git check) | -| Rules | 0 | -| MCP configs | 0 | - -**Installed hooks:** -- `Stop` → `stop-hook-git-check.sh` — blocks session end if there are uncommitted changes or unpushed commits - -**Installed permissions:** -- `Skill` — allows skill invocations - -**Plugins:** Only `blocklist.json` (no active plugins installed) - ---- - -## This Repo (`everything-claude-code` v1.9.0) - -| Component | Repo | -|-----------|------| -| Agents | 28 | -| Skills | 116 | -| Commands | 59 | -| Rules sets | 12 languages + common (60+ rule files) | -| Hooks | Comprehensive system (PreToolUse, PostToolUse, SessionStart, Stop) | -| MCP configs | 1 (Context7 + others) | -| Schemas | 9 JSON validators | -| Scripts/CLI | 46+ Node.js modules + multiple CLIs | -| Tests | 58 test files | -| Install profiles | core, developer, security, research, full | -| Supported harnesses | Claude Code, Codex, Cursor, OpenCode | - ---- - -## Gap Analysis - -### Hooks -- **Current:** 1 Stop hook (git hygiene check) -- **Repo:** Full hook matrix covering: - - Dangerous command blocking (`rm -rf`, force pushes) - - Auto-formatting on file edits - - Dev server tmux enforcement - - Cost tracking - - Session evaluation and governance capture - - MCP health monitoring - -### Agents (28 missing) -The repo provides specialized agents for every major workflow: -- Language reviewers: TypeScript, Python, Go, Java, Kotlin, Rust, C++, Flutter -- Build resolvers: Go, Java, Kotlin, Rust, C++, PyTorch -- Workflow agents: planner, tdd-guide, code-reviewer, security-reviewer, architect -- Automation: loop-operator, doc-updater, refactor-cleaner, harness-optimizer - -### Skills (116 missing) -Domain knowledge modules covering: -- Language patterns (Python, Go, Kotlin, Rust, C++, Java, Swift, Perl, Laravel, Django) -- Testing strategies (TDD, E2E, coverage) -- Architecture patterns (backend, frontend, API design, database migrations) -- AI/ML workflows (Claude API, eval harness, agent loops, cost-aware pipelines) -- Business workflows (investor materials, market research, content engine) - -### Commands (59 missing) -- `/tdd`, `/plan`, `/e2e`, `/code-review` — core dev workflows -- `/sessions`, `/save-session`, `/resume-session` — session persistence -- `/orchestrate`, `/multi-plan`, `/multi-execute` — multi-agent coordination -- `/learn`, `/skill-create`, `/evolve` — continuous improvement -- `/build-fix`, `/verify`, `/quality-gate` — build/quality automation - -### Rules (60+ files missing) -Language-specific coding style, patterns, testing, and security guidelines for: -TypeScript, Python, Go, Java, Kotlin, Rust, C++, C#, Swift, Perl, PHP, and common/cross-language rules. - ---- - -## Recommendations - -### Immediate value (core install) -Run `ecc install --profile core` to get: -- Core agents (code-reviewer, planner, tdd-guide, security-reviewer) -- Essential skills (tdd-workflow, coding-standards, security-review) -- Key commands (/tdd, /plan, /code-review, /build-fix) - -### Full install -Run `ecc install --profile full` to get all 28 agents, 116 skills, and 59 commands. - -### Hooks upgrade -The current Stop hook is solid. The repo's `hooks.json` adds: -- Dangerous command blocking (safety) -- Auto-formatting (quality) -- Cost tracking (observability) -- Session evaluation (learning) - -### Rules -Adding language rules (e.g., TypeScript, Python) provides always-on coding guidelines without relying on per-session prompts. - ---- - -## What the Current Setup Does Well - -- The `stop-hook-git-check.sh` Stop hook is production-quality and already enforces good git hygiene -- The `Skill` permission is correctly configured -- The setup is clean with no conflicts or cruft - ---- - -## Summary - -The current setup is essentially a blank slate with one well-implemented git hygiene hook. This repo provides a complete, production-tested enhancement layer covering agents, skills, commands, hooks, and rules — with a selective install system so you can add exactly what you need without bloating the configuration. diff --git a/REPO-ASSESSMENT.md b/REPO-ASSESSMENT.md deleted file mode 100644 index 95b2f7d1..00000000 --- a/REPO-ASSESSMENT.md +++ /dev/null @@ -1,196 +0,0 @@ -# Repo & Fork Assessment + Setup Recommendations - -**Date:** 2026-03-21 - ---- - -## What's Available - -### Repo: `Infiniteyieldai/everything-claude-code` - -This is a **fork of `affaan-m/everything-claude-code`** (the upstream project with 50K+ stars, 6K+ forks). - -| Attribute | Value | -|-----------|-------| -| Version | 1.9.0 (current) | -| Status | Clean fork — 1 commit ahead of upstream `main` (the EVALUATION.md doc added in this session) | -| Remote branches | `main`, `claude/evaluate-repo-comparison-ASZ9Y` | -| Upstream sync | Fully synced — last upstream commit merged was the zh-CN docs PR (#728) | -| License | MIT | - -**This is the right repo to work from.** It's the latest upstream version with no divergence or merge conflicts. - ---- - -### Current `~/.claude/` Installation - -| Component | Installed | Available in Repo | -|-----------|-----------|-------------------| -| Agents | 0 | 28 | -| Skills | 0 | 116 | -| Commands | 0 | 59 | -| Rules | 0 | 60+ files (12 languages) | -| Hooks | 1 (git Stop check) | Full PreToolUse/PostToolUse matrix | -| MCP configs | 0 | 1 (Context7) | - -The existing Stop hook (`stop-hook-git-check.sh`) is solid — blocks session end on uncommitted/unpushed work. Keep it. - ---- - -## Install Profile Recommendations - -The repo ships 5 install profiles. Choose based on your primary use case: - -### Profile: `core` (Minimum viable setup) -> Fastest to install. Gets you commands, core agents, hooks runtime, and quality workflow. - -**Best for:** Trying ECC out, minimal footprint, or a constrained environment. - -```bash -node scripts/install-plan.js --profile core -node scripts/install-apply.js -``` - -**Installs:** rules-core, agents-core, commands-core, hooks-runtime, platform-configs, workflow-quality - ---- - -### Profile: `developer` (Recommended for daily dev work) -> The default engineering profile for most ECC users. - -**Best for:** General software development across app codebases. - -```bash -node scripts/install-plan.js --profile developer -node scripts/install-apply.js -``` - -**Adds over core:** framework-language skills, database patterns, orchestration commands - ---- - -### Profile: `security` -> Baseline runtime + security-specific agents and rules. - -**Best for:** Security-focused workflows, code audits, vulnerability reviews. - ---- - -### Profile: `research` -> Investigation, synthesis, and publishing workflows. - -**Best for:** Content creation, investor materials, market research, cross-posting. - ---- - -### Profile: `full` -> Everything — all 18 modules. - -**Best for:** Power users who want the complete toolkit. - -```bash -node scripts/install-plan.js --profile full -node scripts/install-apply.js -``` - ---- - -## Priority Additions (High Value, Low Risk) - -Regardless of profile, these components add immediate value: - -### 1. Core Agents (highest ROI) - -| Agent | Why it matters | -|-------|----------------| -| `planner.md` | Breaks complex tasks into implementation plans | -| `code-reviewer.md` | Quality and maintainability review | -| `tdd-guide.md` | TDD workflow (RED→GREEN→IMPROVE) | -| `security-reviewer.md` | Vulnerability detection | -| `architect.md` | System design & scalability decisions | - -### 2. Key Commands - -| Command | Why it matters | -|---------|----------------| -| `/plan` | Implementation planning before coding | -| `/tdd` | Test-driven workflow | -| `/code-review` | On-demand review | -| `/build-fix` | Automated build error resolution | -| `/learn` | Extract patterns from current session | - -### 3. Hook Upgrades (from `hooks/hooks.json`) -The repo's hook system adds these over the current single Stop hook: - -| Hook | Trigger | Value | -|------|---------|-------| -| `block-no-verify` | PreToolUse: Bash | Blocks `--no-verify` git flag abuse | -| `pre-bash-git-push-reminder` | PreToolUse: Bash | Pre-push review reminder | -| `doc-file-warning` | PreToolUse: Write | Warns on non-standard doc files | -| `suggest-compact` | PreToolUse: Edit/Write | Suggests compaction at logical intervals | -| Continuous learning observer | PreToolUse: * | Captures tool use patterns for skill improvement | - -### 4. Rules (Always-on guidelines) -The `rules/common/` directory provides baseline guidelines that fire on every session: -- `security.md` — Security guardrails -- `testing.md` — 80%+ coverage requirement -- `git-workflow.md` — Conventional commits, branch strategy -- `coding-style.md` — Cross-language style standards - ---- - -## What to Do With the Fork - -### Option A: Use as upstream tracker (current state) -Keep the fork synced with `affaan-m/everything-claude-code` upstream. Periodically merge upstream changes: -```bash -git fetch upstream -git merge upstream/main -``` -Install from the local clone. This is clean and maintainable. - -### Option B: Customize the fork -Add personal skills, agents, or commands to the fork. Good for: -- Business-specific domain skills (your vertical) -- Team-specific coding conventions -- Custom hooks for your stack - -The fork already has the EVALUATION.md and REPO-ASSESSMENT.md docs — that's fine for a working fork. - -### Option C: Install from npm (simplest for fresh machines) -```bash -npx ecc-universal install --profile developer -``` -No need to clone the repo. This is the recommended install method for most users. - ---- - -## Recommended Setup Steps - -1. **Keep the existing Stop hook** — it's doing its job -2. **Run the developer profile install** from the local fork: - ```bash - cd /path/to/everything-claude-code - node scripts/install-plan.js --profile developer - node scripts/install-apply.js - ``` -3. **Add language rules** for your primary stack (TypeScript, Python, Go, etc.): - ```bash - node scripts/install-plan.js --add rules/typescript - node scripts/install-apply.js - ``` -4. **Enable MCP Context7** for live documentation lookup: - - Copy `mcp-configs/mcp-servers.json` into your project's `.claude/` dir -5. **Review hooks** — enable the `hooks/hooks.json` additions selectively, starting with `block-no-verify` and `pre-bash-git-push-reminder` - ---- - -## Summary - -| Question | Answer | -|----------|--------| -| Is the fork healthy? | Yes — fully synced with upstream v1.9.0 | -| Other forks to consider? | None visible in this environment; upstream `affaan-m/everything-claude-code` is the source of truth | -| Best install profile? | `developer` for day-to-day dev work | -| Biggest gap in current setup? | 0 agents installed — add at minimum: planner, code-reviewer, tdd-guide, security-reviewer | -| Quickest win? | Run `node scripts/install-plan.js --profile core && node scripts/install-apply.js` |