Skip to content

Commit 21e642c

Browse files
jeremyederclaude
andcommitted
docs: Update CLAUDE.md to reflect current project status
Updated documentation to match reality: - Version: v1.0.0 → v1.23.0 - Self-assessment: 75.4 → 80.0/100 (Gold) - Assessors: 10 → 13 implemented (9 stubs remaining) - Last updated: 2025-11-21 → 2025-11-22 Changes: - Added repomix.py to architecture diagram - Updated stub assessor count (15 → 9) - Restructured roadmap to show v1.x (current), v2.0 (next), v3.0 (future) - Removed outdated "P0 fixes" from Known Issues - Changed "NEW in v1.1" labels to "Feature" (we're at v1.23) - Updated all version references throughout document 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f06b2a8 commit 21e642c

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

CLAUDE.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
**Purpose**: Assess repositories against agent-ready best practices and generate actionable reports.
44

5-
**Last Updated**: 2025-11-21
5+
**Last Updated**: 2025-11-22
66

77
---
88

99
## Overview
1010

1111
AgentReady is a Python CLI tool that evaluates repositories against 25 carefully researched attributes that make codebases more effective for AI-assisted development. It generates interactive HTML reports, version-control friendly Markdown reports, and machine-readable JSON output.
1212

13-
**Current Status**: v1.0.0 - Core assessment engine complete, 10/25 attributes implemented, report schema versioning enabled
13+
**Current Status**: v1.23.0 - Core assessment engine complete, 13/25 attributes implemented, LLM-powered learning, research report management
1414

15-
**Self-Assessment Score**: 75.4/100 (Gold) - See `examples/self-assessment/`
15+
**Self-Assessment Score**: 80.0/100 (Gold) - See `examples/self-assessment/`
1616

1717
---
1818

@@ -48,7 +48,7 @@ agentready migrate-report old-report.json --to 2.0.0
4848

4949
## Continuous Learning Loop (LLM-Powered)
5050

51-
**NEW in v1.1**: Extract high-quality skills from assessments using Claude API
51+
**Feature**: Extract high-quality skills from assessments using Claude API
5252

5353
The `learn` command analyzes assessment results to identify successful patterns and generates Claude Code skills. With `--enable-llm`, it uses Claude Sonnet 4.5 to create detailed, context-aware skill documentation.
5454

@@ -120,9 +120,9 @@ agentready learn . --enable-llm --output-format all
120120

121121
---
122122

123-
## Research Report Management (NEW)
123+
## Research Report Management
124124

125-
**NEW in v1.1**: Utilities for maintaining the research report (agent-ready-codebase-attributes.md)
125+
**Feature**: Utilities for maintaining the research report (agent-ready-codebase-attributes.md)
126126

127127
The `research` command group provides tools to validate, update, and format research reports following the schema defined in `contracts/research-report-schema.md`.
128128

@@ -197,7 +197,8 @@ src/agentready/
197197
│ ├── code_quality.py # Type annotations, complexity
198198
│ ├── testing.py # Test coverage, pre-commit hooks
199199
│ ├── structure.py # Standard layout, gitignore
200-
│ └── stub_assessors.py # 15 not-yet-implemented assessors
200+
│ ├── repomix.py # Repomix configuration assessor
201+
│ └── stub_assessors.py # 9 remaining stub assessors (12 implemented)
201202
├── learners/ # Pattern extraction and LLM enrichment
202203
│ ├── pattern_extractor.py # Heuristic skill extraction
203204
│ ├── skill_generator.py # SKILL.md generation
@@ -414,35 +415,34 @@ chore: Update dependencies
414415

415416
## Known Issues & Limitations
416417

417-
1. **Stub Assessors**: 15/25 assessors return "not_applicable" - need implementation
418-
2. **No Lock File**: Intentionally excluded for library project
419-
3. **No Pre-commit Hooks**: Not yet configured (planned P0 fix)
420-
4. **HTML Report Design**: Current color scheme needs improvement (P0 fix)
421-
5. **Report Metadata**: Missing repository context in header (P0 fix)
418+
1. **Stub Assessors**: 9/25 assessors still return "not_applicable" - need implementation
419+
2. **No Lock File**: Intentionally excluded for library project (assessed as deliberate choice)
420+
3. **Test Coverage**: Currently at ~37%, targeting >80% for production readiness
422421

423422
---
424423

425424
## Roadmap
426425

427-
### v1.1 - Critical UX Fixes (Next Sprint)
428-
- **P0**: Add report header with repository metadata
429-
- **P0**: Redesign HTML report (larger fonts, better colors)
430-
431-
### v1.2 - Automation & Integration
432-
- **P1**: Implement `agentready align` subcommand (automated remediation)
426+
### v1.x - Current Development (In Progress)
427+
- ✅ LLM-powered learning and skill extraction
428+
- ✅ Research report management commands
429+
- ✅ Lock files, conventional commits, gitignore assessors
430+
- ✅ Repomix configuration assessor
431+
- **In Progress**: Expand remaining 9 stub assessors
432+
- **In Progress**: Improve test coverage to >80%
433+
434+
### v2.0 - Automation & Integration (Next)
435+
- **P1**: Implement `agentready bootstrap` subcommand (automated remediation)
436+
- **P1**: Implement `agentready align` subcommand (automated alignment)
433437
- **P2**: GitHub App integration (badges, status checks, PR comments)
434438
- **P2**: Interactive dashboard (one-click remediation)
435439

436-
### v1.3 - Assessor Expansion
437-
- Expand 15 stub assessors
438-
- Add AI-powered assessors (type annotations, docstrings)
439-
- Improve test coverage to >80%
440-
441-
### v2.0 - Enterprise Features
442-
- ✅ Report schema versioning (v1.0.0)
440+
### v3.0 - Enterprise Features (Future)
441+
- ✅ Report schema versioning
443442
- Customizable HTML themes with dark/light toggle
444443
- Organization-wide dashboards
445444
- Historical trend analysis
445+
- AI-powered assessors with deeper code analysis
446446

447447
See `BACKLOG.md` for full feature list.
448448

@@ -464,7 +464,7 @@ See `BACKLOG.md` for full feature list.
464464
- **GITHUB_ISSUES.md** - GitHub-ready issue templates
465465
- **README.md** - User-facing documentation
466466
- **specs/** - Feature specifications and design documents
467-
- **examples/self-assessment/** - AgentReady's own assessment (75.4/100 Gold)
467+
- **examples/self-assessment/** - AgentReady's own assessment (80.0/100 Gold)
468468

469469
---
470470

@@ -551,6 +551,6 @@ Use the @agent-github-pages-docs to revise all documentation in docs/ based on:
551551

552552
---
553553

554-
**Last Updated**: 2025-11-21 by Jeremy Eder
555-
**AgentReady Version**: 1.0.0
556-
**Self-Assessment**: 75.4/100 (Gold) ✨
554+
**Last Updated**: 2025-11-22 by Jeremy Eder
555+
**AgentReady Version**: 1.23.0
556+
**Self-Assessment**: 80.0/100 (Gold) ✨

0 commit comments

Comments
 (0)