Skip to content

Commit

Permalink
Fixed nextest install line in CONTRIBUTING.md (#9929)
Browse files Browse the repository at this point in the history
## Summary

I noticed the example line in CONTRIBUTING.md:

```shell
cargo install nextest
```

Didn't appear to install the intended package cargo-nextest.


![nextest](https://github.com/astral-sh/ruff/assets/12672027/7bbdd9c3-c35a-464a-b586-3e9f777f8373)

So I checked what it [should
be](https://nexte.st/book/installing-from-source.html) and replaced the
line:

```shell
cargo install cargo-nextest --locked
```

## Test Plan

Just checked the cargo install appeared to give sane looking results

---------

Co-authored-by: Charlie Marsh <[email protected]>
  • Loading branch information
owenlamont and charliermarsh authored Feb 11, 2024
1 parent 25868d0 commit a50e278
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ Welcome! We're happy to have you here. Thank you in advance for your contributio
- [`cargo dev`](#cargo-dev)
- [Subsystems](#subsystems)
- [Compilation Pipeline](#compilation-pipeline)
- [Import Categorization](#import-categorization)
- [Project root](#project-root)
- [Package root](#package-root)
- [Import categorization](#import-categorization-1)

## The Basics

Expand Down Expand Up @@ -80,7 +84,7 @@ We recommend [nextest](https://nexte.st/) to run Ruff's test suite (via `cargo n
though it's not strictly necessary:

```shell
cargo install nextest
cargo install cargo-nextest --locked
```

Throughout this guide, any usages of `cargo test` can be replaced with `cargo nextest run`,
Expand Down

0 comments on commit a50e278

Please sign in to comment.