Skip to content

Commit

Permalink
docs: Update CONTRIBUTING.md with note on cargo-husky
Browse files Browse the repository at this point in the history
  • Loading branch information
ClementTsang committed Aug 27, 2020
1 parent 0ea07c2 commit b3e85b1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down

0 comments on commit b3e85b1

Please sign in to comment.