Splits the 518-line root CLAUDE.md into a 70-line root plus four chained sub-files (skill/, command/, agent/, docs/), all under the 150-line cap, and prunes stale references uncovered by the audit. - CLAUDE.md (518 -> 70): project overview, navigation with @-imports, behavioural guidelines summary, naming reference, license link - skill/CLAUDE.md (85): component flow, Python module architecture, modifying modules, adding templates, tech-stack detection, quality scoring, karpathy skill - command/CLAUDE.md (38): slash command development, top-level .md install layout, skill <-> command integration - agent/CLAUDE.md (70): guardian frontmatter, hook responsibilities, skill <-> agent integration, git triggers - docs/CLAUDE.md (109): install verification, smoke test, manual e2e tests, common operations, release process Stale content removed: - 'Dual Directory Structure' section (claude-md-enhancer/ legacy dir does not exist on disk) - '20-300 lines' / '300-line cap' references rewritten to 150 - '~/.claude/commands/enhance-claude-md/' bundle paths rewritten to top-level '.md' files (matching the new installer layout) - 'Three integrated components' updated to five - 'Current Version: 2.0.0' updated to 2.1.0 - '6 examples' in sample_input.json claim corrected (file has 1 scenario) Each sub-file opens with a markdown back-link and @../CLAUDE.md import; root contains @-imports for all four sub-files. Validator passes (status pass) for every file.
3.8 KiB
Parent context: see the root CLAUDE.md for project-wide guidelines and behavioural rules. Chained import:
@../CLAUDE.md
Installation, Testing & Release
Operational guidance for installers, smoke tests, and release management.
Test Installation Scripts
# macOS/Linux
./install.sh
# Choose option 1 (user-level) or 2 (project-level)
# Windows
.\install.ps1
# Same options as above
# Verify after install:
ls -la ~/.claude/skills/claudeforge-skill/
ls -la ~/.claude/skills/karpathy-guidelines/
ls -la ~/.claude/commands/enhance-claude-md.md
ls -la ~/.claude/commands/sync-claude-md.md
ls -la ~/.claude/agents/claude-md-guardian.md
Directory Layout After Install
~/.claude/ # user-level (project-level mirrors under ./.claude)
├── skills/
│ ├── claudeforge-skill/ # from skill/
│ │ ├── SKILL.md
│ │ ├── analyzer.py
│ │ ├── validator.py
│ │ ├── generator.py
│ │ ├── template_selector.py
│ │ ├── workflow.py
│ │ └── examples/
│ └── karpathy-guidelines/ # from skill/karpathy-guidelines/
│ └── SKILL.md
├── commands/
│ ├── enhance-claude-md.md
│ └── sync-claude-md.md
└── agents/
└── claude-md-guardian.md
Smoke Test (run from repo root)
python3 - <<'PY'
import sys; sys.path.insert(0, 'skill')
from validator import BestPracticesValidator
from template_selector import TemplateSelector
from generator import ContentGenerator
assert BestPracticesValidator.MAX_RECOMMENDED_LINES == 150
for cfg in TemplateSelector.TEAM_SIZE_TEMPLATES.values():
assert cfg['target_lines'] <= 150
ctx = {'type':'fullstack','tech_stack':['typescript','python'],
'team_size':'medium','phase':'production','workflows':['cicd']}
out = ContentGenerator(ctx).generate_root_file()
assert len(out.splitlines()) <= 150
assert '## Behavioral Guidelines' in out
print('smoke ok')
PY
Run after any change to skill/, command/, or agent/.
Manual End-to-End Tests
Fresh project init:
mkdir test-project && cd test-project && git init && npm init -y- Run
/enhance-claude-md. - Confirm generated CLAUDE.md ≤ 150 lines, contains
## Behavioral Guidelines, has tech detection right.
Existing project enhance:
- Seed
CLAUDE.mdwith one short section. - Run
/enhance-claude-md; confirm quality score reported, missing sections proposed,## Behavioral Guidelinesappended if absent.
Guardian agent sync:
- Add a new dependency and create a new directory.
- Open a new Claude Code session —
SessionStartfires. - Confirm the agent updates Tech Stack / Project Structure and quality re-validates.
Sync command:
- In a repo with stale CLAUDE.md references, run
/sync-claude-md. - Confirm stale lines flagged, 150-cap enforced via split, root ↔ sub chain repaired, diff left staged for the user.
Common Operations
Update a reference template: edit skill/examples/<name>-CLAUDE.md, then add a matching scenario to skill/sample_input.json.
Update quality scoring: edit skill/analyzer.py → calculate_quality_score(). Re-run the smoke test.
Update installer: edit install.sh / install.ps1 (paths, copy logic, backup logic, hooks). Test both user-level and project-level on a throwaway directory.
Release Process
- Update
CHANGELOG.mdunder a new version header. - Bump the version in
README.md,skill/SKILL.md, and.claude-plugin/plugin.json. git tag -a vX.Y.Z -m "Release vX.Y.Z".git push origin vX.Y.Z.- Create the GitHub release with a CHANGELOG excerpt.
Versioning is semver. See docs/MIGRATION_V2.md for the v1 → v2 upgrade path.