Contribution Guide

Coding Standards

You must apply the latest rustfmt (formtter) and clippy (linter) as follows:

$ cargo fmt --all
$ cargo clippy

If any warnings are emitted, you need to fix them.

For other coding styles that can not be covered with the above tools, follow Rust's Style Guildelines as much as possible.

Before creating a pull request, please make sure that the unit tests and benchmarks pass in your environment:

$ cargo test
$ cargo +nightly bench

This project adopts Semantic Versioning.