Introduction
This document is a collection of Rust coding guidelines used at Chainbound. It is meant primarily for internal use, but may be useful to others.
Structure
Each guideline is in its own file, and is numbered and titled. An example could be: RCG 111: Single Writer Principle
. We use either the number or the title to refer to the guideline. These guidelines are also meant to be used by AI code review agents to check for compliance.
Inspiration
- https://github.com/rust-unofficial/patterns
- https://rust-lang.github.io/api-guidelines
- https://pingcap.github.io/style-guide/rust/
- https://deterministic.space/elegant-apis-in-rust.html
- https://github.com/libp2p/rust-libp2p/blob/master/docs/coding-guidelines.md