Skip to content
This repository was archived by the owner on May 18, 2022. It is now read-only.

Latest commit

 

History

History
37 lines (28 loc) · 1.32 KB

DEVELOPER_DOCUMENTATION.md

File metadata and controls

37 lines (28 loc) · 1.32 KB

Developer Documentation

Style Conventions

Generally speaking, code will be stylized following industry standard for the rust language. There are few exceptions and these are noted below.

General rules

  • Favor strongly typed vs untyped data.
  • Favor structs over json.
  • Favor collections over arrays.
  • It's not done until comments, documentation and scripts are complete.
  • Design for SOLID, SOC and DRY

Non use of snake case

Snake case is not to be used for the following:

  • crates
  • mods
  • file names
  • traits
  • structures
  • enums and enum members

An exception is made for non public test mod.

Alphabetic ordering

Any form of code that is done in a list like pattern must be alphabetical unless noted otherwise.

Extern crates

Keep these alphabetical and only in the main source file for a crate (main.rs or lib.rs). List crates imported in Cargo.toml first following those imported from this project.

use statements

Keep these alphabetical. List uses imported from extern crates first, following those imported from this project.

Something to think about

Consider creating a rustfmt.toml to enforce formatting.