Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

58 lines (37 loc) · 1.31 KB

Contributing to vlq

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

Code of Conduct

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

Building

To build for the host target (for use with testing):

$ cargo build

Testing

To run all the tests:

$ 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 nightly
$ cargo install -f rustfmt-nightly

Ensure that ~/.cargo/bin is on your path.

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

$ cargo fmt