Skip to content

Commit

Permalink
Reflect current Contributing practices (#424)
Browse files Browse the repository at this point in the history
  • Loading branch information
DanGould authored Dec 3, 2024
2 parents a1fbac5 + a346463 commit 027b082
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 027b082

Please sign in to comment.