alwin.berger/FRET-LibAFL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
FRET-LibAFL/CONTRIBUTING.md
Romain Malmain 963afc3e5c
Pre-commit hooks (#2241) 
* add pre-commit hook.
example of hook with fmt check.

* Add `CONTRIBUTING.md`.
2024-05-28 11:45:13 +02:00

1.0 KiB
Raw Permalink Blame History

How to Contribute to LibAFL

For bugs, feel free to open issues or contact us directly. Thank you for your support. <3

Pull Request guideline

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 cfgs)
  • run cargo +nightly fmt on your code before pushing
  • check the output of cargo clippy --all or ./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.

Pre-commit hooks

Some of these checks can be performed automatically during commit using pre-commit. Once the package is installed, simply run pre-commit install to enable the hooks, the checks will run automatically before the commit becomes effective.