ace-review 0.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.ace-defaults/nav/protocols/guide-sources/ace-review.yml +10 -0
- data/.ace-defaults/nav/protocols/prompt-sources/ace-review.yml +36 -0
- data/.ace-defaults/nav/protocols/tmpl-sources/ace-review.yml +10 -0
- data/.ace-defaults/nav/protocols/wfi-sources/ace-review.yml +19 -0
- data/.ace-defaults/review/config.yml +79 -0
- data/.ace-defaults/review/presets/code-fit.yml +64 -0
- data/.ace-defaults/review/presets/code-shine.yml +44 -0
- data/.ace-defaults/review/presets/code-valid.yml +39 -0
- data/.ace-defaults/review/presets/docs.yml +42 -0
- data/.ace-defaults/review/presets/spec.yml +37 -0
- data/CHANGELOG.md +1780 -0
- data/LICENSE +21 -0
- data/README.md +42 -0
- data/Rakefile +14 -0
- data/exe/ace-review +27 -0
- data/exe/ace-review-feedback +17 -0
- data/handbook/guides/code-review-process.g.md +234 -0
- data/handbook/prompts/base/sections.md +23 -0
- data/handbook/prompts/base/system.md +60 -0
- data/handbook/prompts/focus/architecture/atom.md +30 -0
- data/handbook/prompts/focus/architecture/reflection.md +60 -0
- data/handbook/prompts/focus/frameworks/rails.md +40 -0
- data/handbook/prompts/focus/frameworks/vue-firebase.md +45 -0
- data/handbook/prompts/focus/languages/ruby.md +50 -0
- data/handbook/prompts/focus/phase/correctness.md +51 -0
- data/handbook/prompts/focus/phase/polish.md +43 -0
- data/handbook/prompts/focus/phase/quality.md +42 -0
- data/handbook/prompts/focus/quality/performance.md +48 -0
- data/handbook/prompts/focus/quality/security.md +47 -0
- data/handbook/prompts/focus/scope/docs.md +38 -0
- data/handbook/prompts/focus/scope/spec.md +58 -0
- data/handbook/prompts/focus/scope/tests.md +36 -0
- data/handbook/prompts/format/compact.md +12 -0
- data/handbook/prompts/format/detailed.md +39 -0
- data/handbook/prompts/format/standard.md +16 -0
- data/handbook/prompts/guidelines/icons.md +19 -0
- data/handbook/prompts/guidelines/tone.md +21 -0
- data/handbook/prompts/synthesis-review-reports.system.md +318 -0
- data/handbook/prompts/synthesize-feedback.system.md +147 -0
- data/handbook/skills/as-review-apply-feedback/SKILL.md +39 -0
- data/handbook/skills/as-review-package/SKILL.md +36 -0
- data/handbook/skills/as-review-pr/SKILL.md +38 -0
- data/handbook/skills/as-review-run/SKILL.md +30 -0
- data/handbook/skills/as-review-verify-feedback/SKILL.md +31 -0
- data/handbook/templates/review-tasks/task-review-summary.template.md +148 -0
- data/handbook/workflow-instructions/review/apply-feedback.wf.md +212 -0
- data/handbook/workflow-instructions/review/package.wf.md +16 -0
- data/handbook/workflow-instructions/review/pr.wf.md +284 -0
- data/handbook/workflow-instructions/review/run.wf.md +262 -0
- data/handbook/workflow-instructions/review/verify-feedback.wf.md +286 -0
- data/lib/ace/review/atoms/context_limit_resolver.rb +162 -0
- data/lib/ace/review/atoms/diff_boundary_finder.rb +133 -0
- data/lib/ace/review/atoms/feedback_id_generator.rb +66 -0
- data/lib/ace/review/atoms/feedback_slug_generator.rb +61 -0
- data/lib/ace/review/atoms/feedback_state_validator.rb +98 -0
- data/lib/ace/review/atoms/pr_comment_formatter.rb +325 -0
- data/lib/ace/review/atoms/preset_validator.rb +103 -0
- data/lib/ace/review/atoms/priority_filter.rb +115 -0
- data/lib/ace/review/atoms/retry_with_backoff.rb +75 -0
- data/lib/ace/review/atoms/slug_generator.rb +50 -0
- data/lib/ace/review/atoms/token_estimator.rb +86 -0
- data/lib/ace/review/cli/commands/feedback/create.rb +173 -0
- data/lib/ace/review/cli/commands/feedback/list.rb +280 -0
- data/lib/ace/review/cli/commands/feedback/resolve.rb +109 -0
- data/lib/ace/review/cli/commands/feedback/session_discovery.rb +70 -0
- data/lib/ace/review/cli/commands/feedback/show.rb +177 -0
- data/lib/ace/review/cli/commands/feedback/skip.rb +125 -0
- data/lib/ace/review/cli/commands/feedback/verify.rb +149 -0
- data/lib/ace/review/cli/commands/feedback.rb +79 -0
- data/lib/ace/review/cli/commands/review.rb +378 -0
- data/lib/ace/review/cli/feedback_cli.rb +71 -0
- data/lib/ace/review/cli.rb +103 -0
- data/lib/ace/review/errors.rb +146 -0
- data/lib/ace/review/models/feedback_item.rb +216 -0
- data/lib/ace/review/models/review_options.rb +208 -0
- data/lib/ace/review/models/reviewer.rb +181 -0
- data/lib/ace/review/molecules/context_composer.rb +123 -0
- data/lib/ace/review/molecules/context_extractor.rb +159 -0
- data/lib/ace/review/molecules/feedback_directory_manager.rb +183 -0
- data/lib/ace/review/molecules/feedback_file_reader.rb +178 -0
- data/lib/ace/review/molecules/feedback_file_writer.rb +210 -0
- data/lib/ace/review/molecules/feedback_synthesizer.rb +588 -0
- data/lib/ace/review/molecules/gh_cli_executor.rb +124 -0
- data/lib/ace/review/molecules/gh_comment_poster.rb +205 -0
- data/lib/ace/review/molecules/gh_comment_resolver.rb +199 -0
- data/lib/ace/review/molecules/gh_pr_comment_fetcher.rb +408 -0
- data/lib/ace/review/molecules/gh_pr_fetcher.rb +240 -0
- data/lib/ace/review/molecules/llm_executor.rb +142 -0
- data/lib/ace/review/molecules/multi_model_executor.rb +278 -0
- data/lib/ace/review/molecules/nav_prompt_resolver.rb +145 -0
- data/lib/ace/review/molecules/pr_task_spec_resolver.rb +58 -0
- data/lib/ace/review/molecules/preset_manager.rb +494 -0
- data/lib/ace/review/molecules/prompt_composer.rb +76 -0
- data/lib/ace/review/molecules/prompt_resolver.rb +168 -0
- data/lib/ace/review/molecules/strategies/adaptive_strategy.rb +193 -0
- data/lib/ace/review/molecules/strategies/chunked_strategy.rb +459 -0
- data/lib/ace/review/molecules/strategies/full_strategy.rb +114 -0
- data/lib/ace/review/molecules/subject_extractor.rb +315 -0
- data/lib/ace/review/molecules/subject_filter.rb +199 -0
- data/lib/ace/review/molecules/subject_strategy.rb +96 -0
- data/lib/ace/review/molecules/task_report_saver.rb +161 -0
- data/lib/ace/review/molecules/task_resolver.rb +48 -0
- data/lib/ace/review/organisms/feedback_manager.rb +386 -0
- data/lib/ace/review/organisms/review_manager.rb +1059 -0
- data/lib/ace/review/version.rb +7 -0
- data/lib/ace/review.rb +135 -0
- metadata +351 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: correctness
|
|
3
|
+
description: Correctness-focused review - logic errors, missing functionality, and bugs
|
|
4
|
+
last-updated: '2026-02-16'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Correctness Focus
|
|
8
|
+
|
|
9
|
+
## What to Review
|
|
10
|
+
|
|
11
|
+
### Logic Errors & Bugs
|
|
12
|
+
- Off-by-one errors, boundary conditions, nil/null handling
|
|
13
|
+
- Incorrect boolean logic, missing negations, wrong operators
|
|
14
|
+
- Race conditions and concurrency issues
|
|
15
|
+
- Infinite loops or unreachable code paths
|
|
16
|
+
- Type mismatches and coercion errors
|
|
17
|
+
|
|
18
|
+
### Missing Functionality
|
|
19
|
+
- Unhandled edge cases specified in requirements
|
|
20
|
+
- Missing return values or incomplete branches
|
|
21
|
+
- Required validations that are absent
|
|
22
|
+
- Promised behavior not implemented
|
|
23
|
+
|
|
24
|
+
### Error Handling
|
|
25
|
+
- Exceptions that are swallowed silently
|
|
26
|
+
- Missing error handling for I/O, network, or system calls
|
|
27
|
+
- Error messages that leak internal details
|
|
28
|
+
- Recovery paths that leave state inconsistent
|
|
29
|
+
|
|
30
|
+
### Security-Affecting Issues
|
|
31
|
+
- Input that reaches dangerous operations unsanitized
|
|
32
|
+
- Path traversal or injection vectors
|
|
33
|
+
- Secrets or credentials exposed in code or logs
|
|
34
|
+
- Missing authentication or authorization checks
|
|
35
|
+
|
|
36
|
+
### Contract Violations
|
|
37
|
+
- Method signatures that don't match their callers
|
|
38
|
+
- API responses that deviate from documented contracts
|
|
39
|
+
- Broken invariants or preconditions
|
|
40
|
+
- Interface implementations that violate expectations
|
|
41
|
+
|
|
42
|
+
## DO NOT Review
|
|
43
|
+
|
|
44
|
+
The following are explicitly out of scope for this review phase:
|
|
45
|
+
|
|
46
|
+
- **Style & Formatting** — indentation, whitespace, brace placement
|
|
47
|
+
- **Performance Optimization** — algorithm efficiency, caching, query tuning
|
|
48
|
+
- **Naming Conventions** — variable names, method names, class names
|
|
49
|
+
- **Documentation Completeness** — missing docs, comment quality, README updates
|
|
50
|
+
- **Refactoring Suggestions** — alternative designs, DRY improvements, simplification
|
|
51
|
+
- **Alternative Approaches** — different libraries, patterns, or architectures
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: polish
|
|
3
|
+
description: Polish-focused review - simplification, clarity, and readability suggestions
|
|
4
|
+
last-updated: '2026-02-16'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Polish Focus
|
|
8
|
+
|
|
9
|
+
> **ALL findings in this review are NON-BLOCKING suggestions.**
|
|
10
|
+
> Nothing here should prevent merge. These are opportunities to improve clarity,
|
|
11
|
+
> reduce complexity, or clean up after the functional work is complete.
|
|
12
|
+
|
|
13
|
+
## Suggestions for Improvement
|
|
14
|
+
|
|
15
|
+
### Simplification Opportunities
|
|
16
|
+
- Code that could be expressed more concisely without losing clarity
|
|
17
|
+
- Overly defensive checks that duplicate validations done elsewhere
|
|
18
|
+
- Abstractions that add indirection without adding value
|
|
19
|
+
- Conditional chains that could be simplified with guard clauses or early returns
|
|
20
|
+
|
|
21
|
+
### Naming Clarity
|
|
22
|
+
- Variables, methods, or classes whose names don't convey their purpose
|
|
23
|
+
- Abbreviations that reduce readability
|
|
24
|
+
- Boolean methods missing `?` suffix (Ruby convention)
|
|
25
|
+
- Names that are technically accurate but misleading in context
|
|
26
|
+
|
|
27
|
+
### Dead Code & Duplication
|
|
28
|
+
- Unreachable code, unused variables, or commented-out blocks
|
|
29
|
+
- Duplicated logic that could be extracted into a shared method
|
|
30
|
+
- Imports or requires that are no longer needed
|
|
31
|
+
- TODO/FIXME comments that refer to completed work
|
|
32
|
+
|
|
33
|
+
### Documentation Gaps
|
|
34
|
+
- Public methods or APIs missing documentation
|
|
35
|
+
- Complex logic that would benefit from an explanatory comment
|
|
36
|
+
- Missing or outdated inline examples
|
|
37
|
+
- CHANGELOG entries that should accompany the change
|
|
38
|
+
|
|
39
|
+
### Readability
|
|
40
|
+
- Long methods that could be broken into well-named smaller methods
|
|
41
|
+
- Deeply nested conditionals that obscure the main flow
|
|
42
|
+
- Magic numbers or strings that should be named constants
|
|
43
|
+
- Inconsistent ordering of method definitions (public before private)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: quality
|
|
3
|
+
description: Quality-focused review - structure, performance, architecture, and standards
|
|
4
|
+
last-updated: '2026-02-16'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Quality Focus
|
|
8
|
+
|
|
9
|
+
## What to Review
|
|
10
|
+
|
|
11
|
+
### Performance Issues
|
|
12
|
+
- Unnecessary allocations, repeated computation, or redundant I/O
|
|
13
|
+
- N+1 queries, missing indexes, unoptimized database access
|
|
14
|
+
- Missing caching where repeated lookups occur
|
|
15
|
+
- Resource leaks (file handles, connections, memory)
|
|
16
|
+
|
|
17
|
+
### Architecture Compliance
|
|
18
|
+
- ATOM layer violations (atoms with side effects, organisms bypassing molecules)
|
|
19
|
+
- Circular dependencies between modules or layers
|
|
20
|
+
- Components exceeding their single responsibility
|
|
21
|
+
- Improper coupling between unrelated subsystems
|
|
22
|
+
|
|
23
|
+
### Standards Adherence
|
|
24
|
+
- Project coding conventions not followed
|
|
25
|
+
- Inconsistent patterns compared to surrounding code
|
|
26
|
+
- Configuration cascade (ADR-022) not used correctly
|
|
27
|
+
- CLI framework patterns (ADR-023) not followed
|
|
28
|
+
|
|
29
|
+
### Test Coverage Gaps
|
|
30
|
+
- New code paths without corresponding tests
|
|
31
|
+
- Edge cases exercised in code but not in tests
|
|
32
|
+
- Test assertions that don't verify meaningful behavior
|
|
33
|
+
- Missing integration tests for cross-component interactions
|
|
34
|
+
|
|
35
|
+
## DO NOT Review
|
|
36
|
+
|
|
37
|
+
The following are explicitly out of scope for this review phase:
|
|
38
|
+
|
|
39
|
+
- **Cosmetic Improvements** — whitespace, formatting, comment rewording
|
|
40
|
+
- **Alternative Implementations** — different algorithms or libraries that would also work
|
|
41
|
+
- **Polish & Simplification** — renaming for clarity, dead code removal, readability tweaks
|
|
42
|
+
- **Documentation Style** — prose quality, markdown formatting, doc organization
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: performance
|
|
3
|
+
description: Performance optimization review focus
|
|
4
|
+
last-updated: '2026-01-08'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Performance Focus
|
|
8
|
+
|
|
9
|
+
## Performance Optimization Review
|
|
10
|
+
|
|
11
|
+
### Algorithm Efficiency
|
|
12
|
+
- Time complexity analysis
|
|
13
|
+
- Space complexity considerations
|
|
14
|
+
- Optimal data structure selection
|
|
15
|
+
- Algorithm choice justification
|
|
16
|
+
|
|
17
|
+
### Database Performance
|
|
18
|
+
- Query optimization
|
|
19
|
+
- Index usage
|
|
20
|
+
- N+1 query prevention
|
|
21
|
+
- Connection pooling
|
|
22
|
+
- Transaction scope
|
|
23
|
+
|
|
24
|
+
### Caching Strategy
|
|
25
|
+
- Cache invalidation logic
|
|
26
|
+
- Cache key design
|
|
27
|
+
- TTL appropriateness
|
|
28
|
+
- Cache warming strategies
|
|
29
|
+
|
|
30
|
+
### Resource Management
|
|
31
|
+
- Memory usage patterns
|
|
32
|
+
- Connection management
|
|
33
|
+
- File handle cleanup
|
|
34
|
+
- Thread safety
|
|
35
|
+
|
|
36
|
+
### Frontend Performance
|
|
37
|
+
- Bundle size optimization
|
|
38
|
+
- Lazy loading implementation
|
|
39
|
+
- Image optimization
|
|
40
|
+
- Critical rendering path
|
|
41
|
+
- Web Worker usage
|
|
42
|
+
|
|
43
|
+
### Scalability Considerations
|
|
44
|
+
- Horizontal scaling readiness
|
|
45
|
+
- Stateless design
|
|
46
|
+
- Queue and async processing
|
|
47
|
+
- Rate limiting implementation
|
|
48
|
+
- Load balancing compatibility
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: security
|
|
3
|
+
description: Security vulnerability review focus
|
|
4
|
+
last-updated: '2026-01-08'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Security Focus
|
|
8
|
+
|
|
9
|
+
## Enhanced Security Review
|
|
10
|
+
|
|
11
|
+
### Input Validation
|
|
12
|
+
- All user inputs validated and sanitized
|
|
13
|
+
- Proper parameter filtering
|
|
14
|
+
- File upload restrictions
|
|
15
|
+
- Size and type validations
|
|
16
|
+
|
|
17
|
+
### Authentication & Authorization
|
|
18
|
+
- Secure session management
|
|
19
|
+
- Proper password handling
|
|
20
|
+
- Role-based access control
|
|
21
|
+
- Token security (JWT, OAuth)
|
|
22
|
+
|
|
23
|
+
### Data Protection
|
|
24
|
+
- Encryption at rest and in transit
|
|
25
|
+
- PII handling compliance
|
|
26
|
+
- Secure credential storage
|
|
27
|
+
- API key management
|
|
28
|
+
|
|
29
|
+
### Common Vulnerabilities
|
|
30
|
+
- SQL Injection prevention
|
|
31
|
+
- XSS (Cross-Site Scripting) protection
|
|
32
|
+
- CSRF (Cross-Site Request Forgery) tokens
|
|
33
|
+
- Directory traversal prevention
|
|
34
|
+
- Command injection protection
|
|
35
|
+
- XXE (XML External Entity) prevention
|
|
36
|
+
|
|
37
|
+
### Security Headers
|
|
38
|
+
- Content Security Policy
|
|
39
|
+
- X-Frame-Options
|
|
40
|
+
- X-Content-Type-Options
|
|
41
|
+
- Strict-Transport-Security
|
|
42
|
+
|
|
43
|
+
### Dependency Security
|
|
44
|
+
- Known vulnerability scanning
|
|
45
|
+
- License compliance
|
|
46
|
+
- Supply chain security
|
|
47
|
+
- Outdated package detection
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs
|
|
3
|
+
description: Documentation review scope focus
|
|
4
|
+
last-updated: '2026-01-08'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Documentation Scope Focus
|
|
8
|
+
|
|
9
|
+
## FOCUS COMBINATION: Documentation
|
|
10
|
+
|
|
11
|
+
When reviewing documentation, expand your analysis with:
|
|
12
|
+
|
|
13
|
+
### Documentation Quality Section
|
|
14
|
+
Add after "API & Interface Review":
|
|
15
|
+
- README completeness
|
|
16
|
+
- API documentation coverage
|
|
17
|
+
- Code comment quality
|
|
18
|
+
- Example code accuracy
|
|
19
|
+
- Setup instructions clarity
|
|
20
|
+
- Troubleshooting guides
|
|
21
|
+
|
|
22
|
+
### Documentation File Analysis
|
|
23
|
+
Include in "Detailed File-by-File Feedback":
|
|
24
|
+
- Markdown formatting issues
|
|
25
|
+
- Broken links and references
|
|
26
|
+
- Outdated information
|
|
27
|
+
- Missing sections
|
|
28
|
+
- Unclear explanations
|
|
29
|
+
- Grammar and spelling
|
|
30
|
+
|
|
31
|
+
### Documentation Gaps
|
|
32
|
+
Add to "Prioritised Action Items":
|
|
33
|
+
- Undocumented features
|
|
34
|
+
- Missing API endpoints
|
|
35
|
+
- Unclear configuration options
|
|
36
|
+
- Absent migration guides
|
|
37
|
+
- Missing architecture decisions
|
|
38
|
+
- Incomplete changelogs
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: spec
|
|
3
|
+
description: Specification and proposal review scope focus
|
|
4
|
+
last-updated: '2026-01-08'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Specification Review Focus
|
|
8
|
+
|
|
9
|
+
## FOCUS COMBINATION: Specification
|
|
10
|
+
|
|
11
|
+
When reviewing specifications, proposals, or task definitions, analyze:
|
|
12
|
+
|
|
13
|
+
### Goal Clarity
|
|
14
|
+
|
|
15
|
+
- Single, well-defined objective stated clearly
|
|
16
|
+
- No ambiguous terms ("appropriate", "etc.", "and/or", "as needed")
|
|
17
|
+
- Purpose is immediately understandable
|
|
18
|
+
- Success criteria explicitly defined
|
|
19
|
+
- Scope boundaries are clear (what's in vs out)
|
|
20
|
+
|
|
21
|
+
### Usage Expectations
|
|
22
|
+
|
|
23
|
+
- Target audience/user clearly identified
|
|
24
|
+
- Usage scenarios or user stories provided
|
|
25
|
+
- Expected inputs and outputs defined
|
|
26
|
+
- Integration points with existing systems described
|
|
27
|
+
- Constraints and limitations stated
|
|
28
|
+
|
|
29
|
+
### Test Strategy
|
|
30
|
+
|
|
31
|
+
- Acceptance criteria are testable and verifiable
|
|
32
|
+
- Test scenarios or examples provided
|
|
33
|
+
- Edge cases and error conditions considered
|
|
34
|
+
- Performance expectations quantified where applicable
|
|
35
|
+
- Validation approach defined
|
|
36
|
+
|
|
37
|
+
### Completeness Check
|
|
38
|
+
|
|
39
|
+
- All required sections present
|
|
40
|
+
- Dependencies identified and documented
|
|
41
|
+
- Assumptions explicitly stated
|
|
42
|
+
- Risks or unknowns acknowledged
|
|
43
|
+
- No undefined references or placeholders
|
|
44
|
+
|
|
45
|
+
### Implementation Feasibility
|
|
46
|
+
|
|
47
|
+
- Requirements are technically achievable
|
|
48
|
+
- Effort estimates are realistic
|
|
49
|
+
- Required resources/dependencies available
|
|
50
|
+
- No contradictory requirements
|
|
51
|
+
- Constraints are reasonable and achievable
|
|
52
|
+
|
|
53
|
+
### Consistency & Traceability
|
|
54
|
+
|
|
55
|
+
- Terminology used consistently throughout
|
|
56
|
+
- No contradicting statements
|
|
57
|
+
- Requirements traceable to goals
|
|
58
|
+
- Changes from previous versions noted (if applicable)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tests
|
|
3
|
+
description: Test quality and coverage review scope focus
|
|
4
|
+
last-updated: '2026-01-08'
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Test Scope Focus
|
|
8
|
+
|
|
9
|
+
## FOCUS COMBINATION: Tests
|
|
10
|
+
|
|
11
|
+
When reviewing test files, expand your analysis with:
|
|
12
|
+
|
|
13
|
+
### Test Quality & Coverage (Expanded)
|
|
14
|
+
- Detailed test framework analysis (RSpec, Jest, Vitest, etc.)
|
|
15
|
+
- Coverage metrics and gaps
|
|
16
|
+
- Test organization and naming
|
|
17
|
+
- Assertion quality and specificity
|
|
18
|
+
- Mock/stub appropriateness
|
|
19
|
+
- Edge case coverage
|
|
20
|
+
- Error condition testing
|
|
21
|
+
- Integration test requirements
|
|
22
|
+
|
|
23
|
+
### Test Architecture Alignment
|
|
24
|
+
- Test structure mirrors code structure
|
|
25
|
+
- Proper test isolation
|
|
26
|
+
- Shared examples and helpers usage
|
|
27
|
+
- Test data management
|
|
28
|
+
- Fixture and factory patterns
|
|
29
|
+
|
|
30
|
+
### Test File Analysis
|
|
31
|
+
Include test files in "Detailed File-by-File Feedback" with focus on:
|
|
32
|
+
- Test completeness
|
|
33
|
+
- Test clarity and documentation
|
|
34
|
+
- Test performance
|
|
35
|
+
- Flaky test identification
|
|
36
|
+
- Test maintainability
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Compact Review Format
|
|
2
|
+
|
|
3
|
+
## Minimalist Output Structure
|
|
4
|
+
|
|
5
|
+
Focus only on:
|
|
6
|
+
1. **Critical Issues** - Must fix before merge
|
|
7
|
+
2. **High Priority** - Should fix before merge
|
|
8
|
+
3. **Approval Status** - Single line recommendation
|
|
9
|
+
|
|
10
|
+
Use bullet points and keep descriptions under 50 words each.
|
|
11
|
+
No detailed explanations unless critical for understanding.
|
|
12
|
+
Omit sections with no findings.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Detailed Review Format
|
|
2
|
+
|
|
3
|
+
## Enhanced Output Structure
|
|
4
|
+
|
|
5
|
+
### Deep Diff Analysis
|
|
6
|
+
For each significant change:
|
|
7
|
+
- **Intent**: What the change aims to achieve
|
|
8
|
+
- **Impact**: Effects on the codebase
|
|
9
|
+
- **Alternatives**: Other approaches considered
|
|
10
|
+
|
|
11
|
+
### Code Quality Assessment
|
|
12
|
+
- **Complexity metrics**: Cyclomatic complexity, cognitive load
|
|
13
|
+
- **Maintainability index**: Based on code patterns
|
|
14
|
+
- **Test coverage delta**: Change in coverage percentage
|
|
15
|
+
|
|
16
|
+
### Architectural Analysis
|
|
17
|
+
- **Pattern compliance**: Adherence to design patterns
|
|
18
|
+
- **Dependency changes**: New or modified dependencies
|
|
19
|
+
- **Component boundaries**: Interface changes
|
|
20
|
+
|
|
21
|
+
### Documentation Impact Assessment
|
|
22
|
+
- **Required updates**: What documentation needs updating
|
|
23
|
+
- **API changes**: Breaking or non-breaking changes
|
|
24
|
+
- **Migration notes**: For breaking changes
|
|
25
|
+
|
|
26
|
+
### Quality Assurance Requirements
|
|
27
|
+
- **Test scenarios**: Additional test cases needed
|
|
28
|
+
- **Integration points**: Areas requiring integration testing
|
|
29
|
+
- **Performance benchmarks**: Metrics to monitor
|
|
30
|
+
|
|
31
|
+
### Security Review
|
|
32
|
+
- **Attack vectors**: Potential security issues
|
|
33
|
+
- **Data flow**: How sensitive data is handled
|
|
34
|
+
- **Compliance**: Regulatory requirements
|
|
35
|
+
|
|
36
|
+
### Refactoring Opportunities
|
|
37
|
+
- **Technical debt**: Areas that could be improved
|
|
38
|
+
- **Code smells**: Patterns that suggest refactoring
|
|
39
|
+
- **Future-proofing**: Preparing for upcoming changes
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Standard Review Format
|
|
2
|
+
|
|
3
|
+
## Output Formatting Rules
|
|
4
|
+
|
|
5
|
+
• Use ✅ / ⚠️ / ❌ icons or colour words (🔴, 🟡, 🟢) for quick scanning.
|
|
6
|
+
• In "Detailed File-by-File" include: **Issue – Severity – Location – Suggestion – (optionally) code snippet**.
|
|
7
|
+
• In "Prioritised Action Items" group by severity:
|
|
8
|
+
🔴 Critical (blocking) / 🟡 High / 🟢 Medium / 🔵 Nice-to-have.
|
|
9
|
+
• In "Approval Recommendation" present tick-box list:
|
|
10
|
+
|
|
11
|
+
[ ] ✅ Approve as-is
|
|
12
|
+
[ ] ✅ Approve with minor changes
|
|
13
|
+
[ ] ⚠️ Request changes (non-blocking)
|
|
14
|
+
[ ] ❌ Request changes (blocking)
|
|
15
|
+
|
|
16
|
+
Pick ONE status and briefly justify.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Icon Usage Guidelines
|
|
2
|
+
|
|
3
|
+
## Visual Indicators
|
|
4
|
+
|
|
5
|
+
### Status Icons
|
|
6
|
+
- ✅ **Success/Good**: Working correctly, best practice followed
|
|
7
|
+
- ⚠️ **Warning**: Potential issue, needs attention
|
|
8
|
+
- ❌ **Error/Blocking**: Must fix, prevents merge
|
|
9
|
+
- 💡 **Suggestion**: Improvement opportunity
|
|
10
|
+
- ❓ **Question**: Needs clarification
|
|
11
|
+
- 📝 **Note**: Important information
|
|
12
|
+
- 🎯 **Focus**: Key area for review
|
|
13
|
+
|
|
14
|
+
### Severity Colors
|
|
15
|
+
- 🔴 **Critical**: Blocking issues requiring immediate fix
|
|
16
|
+
- 🟡 **High**: Important issues that should be addressed
|
|
17
|
+
- 🟢 **Medium**: Improvements that would enhance quality
|
|
18
|
+
- 🔵 **Low**: Nice-to-have enhancements
|
|
19
|
+
- ⚪ **Info**: Neutral information or context
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Review Tone Guidelines
|
|
2
|
+
|
|
3
|
+
## Communication Style
|
|
4
|
+
|
|
5
|
+
### Professional Tone
|
|
6
|
+
- Concise and direct feedback
|
|
7
|
+
- Focus on code, not the coder
|
|
8
|
+
- Use "we" instead of "you" when suggesting improvements
|
|
9
|
+
- Acknowledge good practices before critiquing
|
|
10
|
+
|
|
11
|
+
### Constructive Feedback
|
|
12
|
+
- Start with positives when possible
|
|
13
|
+
- Frame issues as opportunities for improvement
|
|
14
|
+
- Provide specific examples and alternatives
|
|
15
|
+
- Explain the reasoning behind suggestions
|
|
16
|
+
|
|
17
|
+
### Educational Approach
|
|
18
|
+
- Share knowledge without condescension
|
|
19
|
+
- Link to relevant documentation or resources
|
|
20
|
+
- Explain best practices and patterns
|
|
21
|
+
- Help the author learn and grow
|