From a34646393c58682084f197ed6165f48fdc42ef71 Mon Sep 17 00:00:00 2001 From: DanGould Date: Tue, 3 Dec 2024 12:58:32 -0500 Subject: [PATCH] Reflect current Contributing practices - update lock files with a script - lint with a script --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a59b7f27..bd3d12ef 100644 --- a/README.md +++ b/README.md @@ -112,20 +112,16 @@ cargo update -p zstd-sys --precise 2.0.8+zstd.1.5.5 ### Upgrading dependencies -If your change requires a dependency to be upgraded you must do the following: - -1. Modify `Cargo.toml` -2. Copy `Cargo-minimal.lock` to `Cargo.lock` -3. Trigger cargo to update the required entries in the lock file - use `--precise` using the minimum version number that works -4. Test your change -5. Copy `Cargo.lock` to `Cargo-minimal.lock` -6. Update `Cargo-recent.lock` if it is also behind -7. Commit both lock files together with `Cargo.toml` and your code changes +If your change requires a dependency to be upgraded you must please run `contrib/update-lock-files.sh` before submitting any changes. ## Code Formatting We use the nightly Rust formatter for this project. Please run `rustfmt` using the nightly toolchain before submitting any changes. +## Linting + +We use `clippy` for linting. Please run `contrib/lint.sh` using the nightly toolchain before submitting any changes. + ## License MIT