git checkout -b 123Branch name = issue number only.
git commit -m "#123 feat: add custom class support"Format: #<issue> <type>: <description>
Types: feat, fix, docs, refactor, test, chore
- Title:
123 - Description must include:
Closes #123
Run locally:
cargo +nightly fmt
cargo clippy -- -D warnings
cargo test| Check | Command |
|---|---|
| Format | cargo +nightly fmt --check |
| Lint | cargo clippy -- -D warnings |
| Test | cargo test |
| Coverage | cargo llvm-cov (95%+ required) |
| Rule | Example |
|---|---|
No unwrap() / expect() |
Use ? or .ok_or() |
No unnecessary clone() |
Pass references |
:: only in imports |
use foo::bar ok, foo::bar() bad |
| Doc comments on public items | /// Description |
| Max line width | 99 chars |
See RustManifest