diff options
| author | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-08-26 20:34:22 -0400 |
|---|---|---|
| committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2020-08-26 20:34:22 -0400 |
| commit | b3e85b135a3c2e3fedfd923bf45934f1a4d8c248 (patch) | |
| tree | a7f8e464e87d28be65914f9c8372ef5b42a2d852 /CONTRIBUTING.md | |
| parent | 0ea07c288e4590672000869f0e75de021a35a6c9 (diff) | |
docs: Update CONTRIBUTING.md with note on cargo-husky
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed31f95e..bb948b3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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`). |