tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Update CONTRIBUTING.md with note on cargo-husky

This commit is contained in:
ClementTsang 2020-08-26 20:34:22 -04:00
parent 0ea07c288e
commit b3e85b135a
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -44,7 +44,9 @@ If you want to help contribute by submitting a PR, by all means, I'm open! In re
- I use both [clippy](https://github.com/rust-lang/rust-clippy) and [rustfmt](https://github.com/rust-lang/rustfmt) in development (with some settings, see [clippy.toml](./clippy.toml) and [rustfmt.toml](rustfmt.toml)). Note clippy must pass to for PRs to be accepted.
- You can check clippy using `cargo +nightly clippy`.
- You can check clippy using `cargo clippy`.
- I use [cargo-husky](https://github.com/rhysd/cargo-husky) to automatically run a clippy check on push. You can disable this in the `Cargo.toml` file if you find this annoying.
- You may notice that I have fern and log as dependencies; this is mostly for easy debugging via the `debug!()` macro. It writes to the
`debug.log` file that will automatically be created if you run in debug mode (so `cargo run`).