Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Testing in Contributing section of README #429

Merged
merged 2 commits into from
Dec 4, 2024
Merged

Document Testing in Contributing section of README #429

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
232f345
Document Testing in Contributing section
DanGould Dec 4, 2024
6b52410
Make contributing doc headings consistent
DanGould Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading