CONTRIBUTING.md

Contributing to memory_units

Hi! We'd love to have your contributions! If you want help or mentorship, reach out to us in a GitHub issue, or ping pepyakin or fitzgen in #rust on irc.mozilla.org and introduce yourself.

• Code of Conduct
• Building and Testing
  • Building
  • Testing
• Automatic Code Formatting

Code of Conduct

We abide by the Rust Code of Conduct and ask that you do as well.

Building and Testing

Building

$ cargo build

Testing

$ cargo test

Automatic Code Formatting

We use rustfmt to enforce a consistent code style across the whole code base.

You can install the latest version of rustfmt with this command:

$ rustup update
$ rustup component add rustfmt-preview

Ensure that ~/.rustup/toolchains/$YOUR_HOST_TARGET/bin/ is on your $PATH.

Once that is taken care of, you can (re)format all code by running this command from the root of the repository:

$ cargo fmt --all