diff --git a/README.md b/README.md index bd3d12ef..d071d7de 100644 --- a/README.md +++ b/README.md @@ -110,15 +110,21 @@ cargo update -p zstd-sys --precise 2.0.8+zstd.1.5.5 ## Contributing +### Testing + +We test a few different features combinations in CI. To run all of the combinations locally, have Docker running and run `contrib/test.sh`. + +If you are adding a new feature please add tests for it. + ### Upgrading dependencies If your change requires a dependency to be upgraded you must please run `contrib/update-lock-files.sh` before submitting any changes. -## Code Formatting +### Code Formatting We use the nightly Rust formatter for this project. Please run `rustfmt` using the nightly toolchain before submitting any changes. -## Linting +### Linting We use `clippy` for linting. Please run `contrib/lint.sh` using the nightly toolchain before submitting any changes.