Thank you for considering contributing to Salah!
- Describe what you expected to happen.
- If possible, include a minimal, complete, and verifiable example to help us identify the issue. This also helps check that the issue is not with your own code.
- Describe what actually happened. Include the full traceback if there was an exception.
- Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch.
- Make sure all commits are verified.
- Make sure there are no trailing spaces in the any of the modified files.
Best way to have a local Rust development environment set up is by using rustup.
There are two direct dependencies for this crate:
These would be installed when you run cargo build (or cargo test).
- Create a branch to identify the issue you would like to work on (e.g.
2287-dry-test-suite) - Using your favorite editor, make your changes, committing as you go.
- Make sure there are no trailing spaces in the any of the modified files.
- Include tests that cover any code changes you make. Make sure the test fails without your patch.
- Push your commits to GitHub and create a pull request.
- Celebrate 🎉
Run the basic test suite with:
cargo test
If you would only like to run a single test you can do so with:
cargo test <name of test>
Docs for the crate can be locally built using:
cargo doc --no-deps