SYS-OSS/FRET-LibAFL
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: fixed instruction in CONTRIBUTING.md (#2359)

Browse Source 
* doc: fixed instruction in CONTRIBUTING.md

* Added note for windows users

* fix for calling the clippy script on windows
This commit is contained in:
Nereuxofficial 2024-07-02 19:32:11 +02:00 committed by GitHub
parent eff40320eb
commit 030e5066b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -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.