CONTRIBUTING.md

Rust Developer's guide to web-bot-auth

Welcome to web-bot-auth's contributor guidelines. Please take a look. This should help you get ready to contribute to this repo.

Testing

Crates in this repo provide Rust tests. You can run these manually using:

cargo +stable test --workspace --all-features --all-targets

We also target Cloudflare's worker environment. A basic example exists to confirm our crates work in said environment. Depending on your changes you might need to expand this example or create your own. Incompatibilities can surface only at runtime, so please exercise the example when your change touches the Workers path (such as adding new dependencies). For more information see comment on #74

Code Formatting

Our CI runs rustfmt to check code formatting and clippy to lint. You can run the same yourself before submitting a PR by running:

cargo +stable fmt --workspace -- --check
cargo +stable clippy --workspace --all-features --all-targets -- -D warnings

Style

Additionally, we settled on a three-block use declaration format. This means, use declarations (imports, in other languages) are split into three blocks. The first one is reserved for items provided by Rust's standard library (either std, alloc, or core). The second one is used for adding items from external crates (for example serde or time). The last one is used for internal items (crate, super, or a module).

use std::collections::HashMap;
use std::time::Duration;

use serde::Serialize;

use message_signatures::MessageVerifier;

rather than a single ordered block:

use message_signatures::MessageVerifier;
use serde::Serialize;
use std::time::Duration;
use std::collections::HashMap;