Contributing to wasm-nm

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

• Code of Conduct
• Building
• Testing
• Automatic code formatting

Code of Conduct

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

Building

$ cargo build

Testing

The tests require cargo-readme to be installed:

$ cargo install cargo-readme

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