Initial commit
This commit is contained in:
Zhongwei Li
131
skills/claude-md-auditor/examples/sample_audit_report.md
Normal file
131
skills/claude-md-auditor/examples/sample_audit_report.md
Normal file
@@ -0,0 +1,131 @@
|
||||
# CLAUDE.md Audit Report
|
||||
|
||||
**File**: `/Users/connor/.claude/CLAUDE.md`
|
||||
|
||||
**Generated**: 2025-10-26 09:32:18
|
||||
|
||||
**Tier**: Project
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Executive Summary
|
||||
|
||||
| Metric | Value |
|
||||
|--------|-------|
|
||||
| **Overall Health** | 91/100 (Excellent) |
|
||||
| **Status** | ✅ **HEALTHY** - Minor optimizations available |
|
||||
| **Critical Issues** | 0 |
|
||||
| **High Priority** | 0 |
|
||||
| **Medium Priority** | 1 |
|
||||
| **Low Priority** | 2 |
|
||||
| **Total Findings** | 3 |
|
||||
|
||||
## Score Dashboard
|
||||
|
||||
| Category | Score | Status |
|
||||
|----------|-------|--------|
|
||||
| **Security** | 100/100 | ✅ Excellent |
|
||||
| **Official Compliance** | 100/100 | ✅ Excellent |
|
||||
| **Best Practices** | 100/100 | ✅ Excellent |
|
||||
| **Research Optimization** | 97/100 | ✅ Excellent |
|
||||
|
||||
## File Metrics
|
||||
|
||||
| Metric | Value | Recommendation |
|
||||
|--------|-------|----------------|
|
||||
| **Lines** | 167 | 100-300 lines ideal |
|
||||
| **Characters** | 6,075 | Keep concise |
|
||||
| **Est. Tokens** | 1,518 | < 3,000 recommended |
|
||||
| **Context Usage (200K)** | 0.76% | < 2% ideal |
|
||||
| **Context Usage (1M)** | 0.15% | Reference only |
|
||||
|
||||
✅ **Assessment**: File length is in optimal range (100-300 lines).
|
||||
|
||||
## Findings
|
||||
|
||||
| Severity | Count | Description |
|
||||
|----------|-------|-------------|
|
||||
| 🚨 **Critical** | 0 | Security risks, immediate action required |
|
||||
| ⚠️ **High** | 0 | Significant issues, fix this sprint |
|
||||
| 📋 **Medium** | 1 | Moderate issues, schedule for next quarter |
|
||||
| ℹ️ **Low** | 2 | Minor improvements, backlog |
|
||||
|
||||
## Findings by Category
|
||||
|
||||
| Category | Count | Description |
|
||||
|----------|-------|-------------|
|
||||
| **Security** | 0 | Security vulnerabilities and sensitive information |
|
||||
| **Official Compliance** | 0 | Compliance with official Anthropic documentation |
|
||||
| **Best Practices** | 0 | Community best practices and field experience |
|
||||
| **Research Optimization** | 1 | Research-based optimizations (lost in the middle, etc.) |
|
||||
| **Structure** | 1 | Document structure and organization |
|
||||
| **Maintenance** | 1 | Maintenance indicators and staleness |
|
||||
|
||||
## Detailed Findings
|
||||
|
||||
|
||||
### 📋 MEDIUM Priority
|
||||
|
||||
#### 1. Potentially Broken File Paths
|
||||
|
||||
**Category**: Maintenance
|
||||
**Source**: Community Guidance
|
||||
|
||||
**Description**: Found 13 file paths that may not exist
|
||||
|
||||
**Impact**: Broken paths mislead developers and indicate stale documentation
|
||||
|
||||
**Remediation**:
|
||||
Verify all file paths and update or remove broken ones
|
||||
|
||||
---
|
||||
|
||||
|
||||
### ℹ️ LOW Priority
|
||||
|
||||
#### 1. Minimal Organization
|
||||
|
||||
**Category**: Structure
|
||||
**Source**: Community Guidance
|
||||
|
||||
**Description**: Only 0 main sections found
|
||||
|
||||
**Impact**: May lack clear structure
|
||||
|
||||
**Remediation**:
|
||||
Organize into sections: Standards, Workflow, Commands, Reference
|
||||
|
||||
---
|
||||
|
||||
#### 2. Critical Content in Middle Position
|
||||
|
||||
**Category**: Research Optimization
|
||||
**Source**: Research Guidance
|
||||
|
||||
**Description**: Most critical standards appear in middle section
|
||||
|
||||
**Impact**: Research shows 'lost in the middle' attention pattern. Critical info at top/bottom gets more attention.
|
||||
|
||||
**Remediation**:
|
||||
Move must-follow standards to top section. Move reference info to bottom. Keep nice-to-have in middle.
|
||||
|
||||
---
|
||||
|
||||
|
||||
## Priority Recommendations
|
||||
|
||||
### 💡 General Recommendations
|
||||
|
||||
- **Regular maintenance**: Schedule quarterly CLAUDE.md reviews
|
||||
- **Team collaboration**: Share CLAUDE.md improvements via PR
|
||||
- **Validate effectiveness**: Test that Claude follows standards without prompting
|
||||
|
||||
---
|
||||
|
||||
|
||||
*Generated by claude-md-auditor v1.0.0*
|
||||
|
||||
*Based on official Anthropic documentation, community best practices, and academic research*
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
# CLAUDE.md
|
||||
|
||||
<!-- Refactored: 2025-10-26 09:32:18 -->
|
||||
<!-- Based on official Anthropic guidelines and best practices -->
|
||||
|
||||
<!-- Tier: Project -->
|
||||
|
||||
# Claude Configuration v4.4.0
|
||||
|
||||
## 🚨 CRITICAL: Must-Follow Standards
|
||||
|
||||
<!-- Place non-negotiable standards here (top position = highest attention) -->
|
||||
|
||||
- [Add critical security requirements]
|
||||
- [Add critical quality gates]
|
||||
- [Add critical workflow requirements]
|
||||
|
||||
## 📋 Project Overview
|
||||
|
||||
**Tech Stack**: [List technologies]
|
||||
**Architecture**: [Architecture pattern]
|
||||
**Purpose**: [Project purpose]
|
||||
|
||||
## 🔧 Development Workflow
|
||||
|
||||
### Git Workflow
|
||||
- Branch pattern: `feature/{name}`, `bugfix/{name}`
|
||||
- Conventional commit messages required
|
||||
- PRs require: tests + review + passing CI
|
||||
|
||||
## 📝 Code Standards
|
||||
|
||||
### TypeScript/JavaScript
|
||||
- TypeScript strict mode: enabled
|
||||
- No `any` types (use `unknown` if needed)
|
||||
- Explicit return types required
|
||||
|
||||
### Testing
|
||||
- Minimum coverage: 80%
|
||||
- Testing trophy: 70% integration, 20% unit, 10% E2E
|
||||
- Test naming: 'should [behavior] when [condition]'
|
||||
|
||||
## 📌 REFERENCE: Common Tasks
|
||||
|
||||
<!-- Bottom position = recency attention, good for frequently accessed info -->
|
||||
|
||||
### Build & Test
|
||||
```bash
|
||||
npm run build # Build production
|
||||
npm test # Run tests
|
||||
npm run lint # Run linter
|
||||
```
|
||||
|
||||
### Key File Locations
|
||||
- Config: `/config/app.config.ts`
|
||||
- Types: `/src/types/index.ts`
|
||||
- Utils: `/src/utils/index.ts`
|
||||
|
||||
## 📚 Detailed Documentation (Imports)
|
||||
|
||||
<!-- Use imports to keep this file lean (<300 lines) -->
|
||||
|
||||
<!-- Example:
|
||||
@docs/architecture.md
|
||||
@docs/testing-strategy.md
|
||||
@docs/deployment.md
|
||||
-->
|
||||
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2025-10-26
|
||||
**Maintained By**: [Team/Owner]
|
||||
|
||||
<!-- Follow official guidance: Keep lean, be specific, use structure -->
|
||||
@@ -0,0 +1,41 @@
|
||||
# Test Project
|
||||
|
||||
## API Configuration
|
||||
- API Key: sk-1234567890abcdefghijklmnop
|
||||
- Database: postgres://admin:password123@192.168.1.42:5432/mydb
|
||||
|
||||
## React Best Practices
|
||||
|
||||
React is a JavaScript library for building user interfaces. It was created
|
||||
by Facebook in 2013. React uses a virtual DOM for efficient updates...
|
||||
|
||||
TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
|
||||
|
||||
Git is a version control system that tracks changes to files.
|
||||
|
||||
## Code Quality
|
||||
- Write good code
|
||||
- Make it clean
|
||||
- Follow best practices
|
||||
- Be consistent
|
||||
- Keep it simple
|
||||
|
||||
## Old Commands
|
||||
Run with Webpack 4
|
||||
Use Node 12
|
||||
|
||||
## Standards (Line 30)
|
||||
- Use 2-space indentation
|
||||
- Prefer single quotes
|
||||
|
||||
## TypeScript Standards (Line 50)
|
||||
- Use 4-space indentation
|
||||
- Prefer double quotes
|
||||
|
||||
## Testing
|
||||
Must use useState for everything
|
||||
All API calls must use POST
|
||||
No files over 200 lines ever
|
||||
|
||||
Documentation at /old/docs/readme.md (moved)
|
||||
Types in /src/oldtypes/index.ts (renamed)
|
||||
Reference in New Issue
Block a user