All function names and variable names should be per Rust convention.
Files should be named in such a way that it's trivial to know what they contain. File names should only be a few words at most.
All files should have a short summary of what they contain.
//! # Summary
//! notation
All functions should have a short summary of what they do. Using
/// # Summary
/// notation
All structs should have a short summary of what they contain. Using
/// # Summary
/// notation
All enums should have a short summary of what they contain. Using
/// # Summary
/// notation
Major sections of code need comments that describe what they contain. To make sure that users can understand the code.
Indentation should be 4 spaces. ( Just set tab to 4 space in your editor of choise )
fn main() {
let x = 1;
let y = 2;
let z = x + y;
}