mirror of
https://github.com/status-im/nim-style-guide.git
synced 2025-02-22 11:08:12 +00:00
e6b937e4ab
* add section on `string` (fixes #4) * expand `Defect` coverage * expand `CatchableError` coverage (fixes #5) * expand `init` vs `new` * expand formatting of split `if` * avoid `Natural` and other `range` types
Introduction
An ever evolving collection of conventions, idioms and tricks that reflects the experience of developing a production-grade application in Nim with a small team of developers.
Build and publish
The style guide is built using mdBook, and published to gh-pages using a github action.
# Install tooling
cargo install mdbook mdbook-toc mdbook-open-on-gh
# Edit book and view through local browser
mdbook serve
Contributing
We welcome contributions to the style guide as long as they match the strict security requirements Status places on Nim code. As with any style guide, some of it comes down to taste and we might reject them based on consistency or whim.