diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9dd4eb1800..becc7c4d9e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,11 @@ For bugs, feel free to open issues or contact us directly. Thank you for your su ## Pull Request guideline -Even though we will gladly assist you in finishing up your PR, try to +Even though we will gladly assist you in finishing up your PR, try to: + - keep all the crates compiling with *stable* rust (hide the eventual non-stable code under [`cfg`s](https://github.com/AFLplusplus/LibAFL/blob/main/libafl/build.rs#L26)) - run `cargo +nightly fmt` on your code before pushing -- check the output of `cargo clippy --all` or `./clippy.sh` +- check the output of `cargo clippy --all` or `.\scripts\clippy.sh` (On windows use `./scripts/clippy.ps1`) - run `cargo build --no-default-features` to check for `no_std` compatibility (and possibly add `#[cfg(feature = "std")]`) to hide parts of your code. Some of the parts in this list may be hard, don't be afraid to open a PR if you cannot fix them by yourself, so we can help. @@ -15,4 +16,4 @@ Some of the parts in this list may be hard, don't be afraid to open a PR if you ### Pre-commit hooks Some of these checks can be performed automatically during commit using [pre-commit](https://pre-commit.com/). -Once the package is installed, simply run `pre-commit install` to enable the hooks, the checks will run automatically before the commit becomes effective. \ No newline at end of file +Once the package is installed, simply run `pre-commit install` to enable the hooks, the checks will run automatically before the commit becomes effective.