Skip to content

Commit

Permalink
doc: fixed instruction in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nereuxofficial committed Jul 2, 2024
1 parent eff4032 commit 9c24ef2
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
- 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.
Expand Down

0 comments on commit 9c24ef2

Please sign in to comment.