Working Rust Code Not Enough
RUST-WORKING-RUST-CODE-NOT-ENOUGH
Summary
Treat compilation as necessary but insufficient evidence for long-lived Rust code. Review API shape, docs, errors, tests, features, dependencies, and module organization because users and maintainers inherit those choices.
Rule
Working Rust code is not enough.
Why
Rust code can compile while still being hard to read, poorly documented, wrongly public, feature-fragile, or painful for downstream users. The compiler is necessary proof, but maintainability and API shape need human design judgment too.
Helps
Helps review Rust changes for API clarity, docs, errors, tests, feature behavior, module shape, and downstream compatibility instead of stopping at compilation.
Limits
Small private scripts may only need to work. Library and long-lived application code should meet a higher bar because future readers and users inherit the shape.
Agent Instruction
Working Rust code is not enough because rust code can compile while still being hard to read, poorly
documented, wrongly public, feature-fragile, or painful for downstream users.Mechanisms
After cargo check, inspect public API, Rustdoc, errors, tests, feature combinations, examples,
dependency floors, and module organization for maintainability problems.