Automaat welcomes contribution from everyone in the form of suggestions, bug reports, pull requests, and feedback. This document gives some guidance if you are thinking of helping us.
Please reach out here in a GitHub issue if we can do anything to help you contribute.
Automaat development is spread across multiple crates, but all active development happens in this repository and can be used for opening any issues related to Automaat.
When reporting a bug or asking for help, please include enough details so that the people helping you can reproduce the behavior you are seeing. For some tips on how to approach this, read about how to produce a Minimal, Complete, and Verifiable example.
When making a feature request, please make it clear what problem you intend to solve with the feature, any ideas for how Automaat could support solving that problem, any possible alternatives, and any disadvantages.
Here's a list of useful resources that can help you during your contributions to the project:
- Rust Language Cheat Sheet
- Rust API Guidelines
- Rust Book
- Rust By Example
- Rust Reference
- Read Rust
- Rust Standard Library
- Rust Compiler Error Index
- Rust Learning Resources
We encourage you to check that the test suite passes locally before submitting a pull request with your changes. If anything does not pass, typically it will be easier to iterate and fix it locally than waiting for the CI servers to run tests for you.
# Test all the crates in the workspace
cargo test --allIn all Automaat-related communication, we follow the Rust Code of Conduct. For escalation or moderation issues please contact Jean jean@blendle.com instead of the Rust moderation team.
the contents of this document were kindly borrowed from serde-rs/serde