Contributing

Contributions are welcome. 🙂

Issues

Please include logs and error messages.

Pull requests should pass our checks.

Code is formatted using:

$ cargo fmt --all

Code is linted:

$ cargo clippy --all-features --all-targets --workspace -- -D warnings
$ yamllint --strict .

Tests come in unit and integration tests. The latter require credentials. Run ALL tests by using:

$ cargo test --all-features --workspace

You can skip integration tests:

$ cargo test --all-features --workspace -- --skip integration

Pull requests do NOT have access to the test credentials!

Code should have a rough documentation. Docs are checked using:

$ cargo doc --document-private-items --no-deps --all-features --workspace