In actix_failwrap, we welcome contributions from everyone, including bug reports, pull requests, and feedback. This document serves as guidance if you are considering submitting any of the above.
To submit a bug report or feature request, you can open an issue in this
repository: FlakySL/actix_failwrap.
When reporting a bug or requesting help, please include sufficient details to allow others to reproduce the behavior you're encountering. For guidance on how to approach this, read about How to Create a Minimal, Reproducible Example.
When making a feature request, please clearly explain:
- The problem you want to solve
- How actix_failwrap could help address this problem
- Any potential alternatives
- Possible disadvantages of your proposal
Before submitting, please verify that no existing issue addresses your specific problem/request. If you want to elaborate on a problem or discuss it further, you can use our Discord channel at Flaky.
We recommend using the issue templates provided in this repository.
Before adding a feature on your behalf, we'd rather for it to be evaluated in a issue before, we appreciate the time and effort our contributors have and we don't want to waste it, so we'd rather talk about your feature before you working on it.
When submitting a pull request make sure the code you added is tested and documented, if it isn't you will be asked to document/test it before merging.
To add tests please refer to the testing documentation on the tests folder
in the actix_failwrap crate.
This project uses GNU make.
- Run tests using
make test_code, for more information, check each test folder README. - Compile the project using
make build.
The actix_failwrap community follows the Rust Code of Conduct. For moderation issues or escalation, please contact Esteve or Luis at moderation@flaky.es rather than the Rust moderation team.