mirror of
https://github.com/affaan-m/ECC.git
synced 2026-08-29 03:09:38 +02:00
docs(rules): clarify 800-line review ceiling
This commit is contained in:
committed by
Alex Schmitt
parent
e97edd47fc
commit
60e27fe51e
@@ -28,7 +28,7 @@ Before marking code complete:
|
||||
|
||||
- [ ] Code is readable and well-named
|
||||
- [ ] Functions are focused (<50 lines)
|
||||
- [ ] Files are cohesive (<800 lines)
|
||||
- [ ] Source files are cohesive (under the 800-line soft maintainability ceiling, or include a reason for a deliberate exception)
|
||||
- [ ] No deep nesting (>4 levels)
|
||||
- [ ] Errors are handled explicitly
|
||||
- [ ] No hardcoded secrets or credentials
|
||||
@@ -54,7 +54,7 @@ Before marking code complete:
|
||||
|-------|---------|--------|
|
||||
| CRITICAL | Security vulnerability or data loss risk | **BLOCK** - Must fix before merge |
|
||||
| HIGH | Bug or significant quality issue | **WARN** - Should fix before merge |
|
||||
| MEDIUM | Maintainability concern | **INFO** - Consider fixing |
|
||||
| MEDIUM | Maintainability concern, including an unexplained source file over the soft 800-line ceiling | **INFO** - Consider fixing |
|
||||
| LOW | Style or minor suggestion | **NOTE** - Optional |
|
||||
|
||||
## Agent Usage
|
||||
|
||||
@@ -36,7 +36,8 @@ Rationale: Immutable data prevents hidden side effects, makes debugging easier,
|
||||
|
||||
MANY SMALL FILES > FEW LARGE FILES:
|
||||
- High cohesion, low coupling
|
||||
- 200-400 lines typical, 800 max
|
||||
- 200-400 lines typical, with 800 lines as a soft maintainability ceiling for source files
|
||||
- Test, generated, and vendored files may exceed the ceiling when their size is justified by their role
|
||||
- Extract utilities from large modules
|
||||
- Organize by feature/domain, not by type
|
||||
|
||||
|
||||
Reference in New Issue
Block a user