mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-15 02:42:45 +08:00
ef770ff29b
- Introduced best practices requirements specification covering code quality, performance, maintainability, error handling, and documentation standards. - Established quality standards with overall quality metrics and mandatory checks for security, code quality, performance, and maintainability. - Created security requirements specification aligned with OWASP Top 10 and CWE Top 25, detailing checks and patterns for common vulnerabilities. - Developed templates for documenting best practice findings, security findings, and generating reports, including structured markdown and JSON formats. - Updated dependencies in the project, ensuring compatibility and stability. - Added test files and README documentation for vector indexing tests.
37 lines
948 B
Markdown
37 lines
948 B
Markdown
# Phase 3: Best Practices Review
|
|
|
|
## Objective
|
|
|
|
Analyze code for best practices violations including code quality, performance issues, and maintainability concerns.
|
|
|
|
## Input
|
|
|
|
- **File Inventory**: From Phase 1 (`.code-review/inventory.json`)
|
|
- **Security Findings**: From Phase 2 (`.code-review/security-findings.json`)
|
|
- **User Arguments**:
|
|
- `--focus best-practices`: Best practices only mode
|
|
- `--check quality,performance,maintainability`: Specific areas to check
|
|
|
|
## Process
|
|
|
|
### Step 1: Code Quality Analysis
|
|
|
|
Check naming conventions, function complexity, code duplication, and dead code detection.
|
|
|
|
### Step 2: Performance Analysis
|
|
|
|
Detect N+1 queries, inefficient algorithms, and memory leaks.
|
|
|
|
### Step 3: Maintainability Analysis
|
|
|
|
Check documentation coverage, test coverage, and dependency management.
|
|
|
|
## Output
|
|
|
|
- best-practices-findings.json
|
|
- Markdown report with recommendations
|
|
|
|
## Next Phase
|
|
|
|
**Phase 4: Report Generation**
|