Skip to content

Commit

Permalink
CONTRIBUTING: Mention how to run pedantic lints from CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
willbush committed Nov 8, 2024
1 parent 9083d6f commit b32aaea
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,33 @@ nix-shell
```

The most important tools and commands in this environment are:

- [rust-analyzer](https://rust-analyzer.github.io/) to have an IDE-like experience for your own editor.

- Running tests:

```bash
cargo test
```
- Linting and formatting:

- Formatting:

```bash
cargo clippy --all-targets
treefmt
```

- Linting:

```bash
cargo clippy --all-targets
```

Optionally, check out extra lints or uncomment them at the top of `main.rs`.

```bash
cargo clippy --all-targets -- -W clippy::nursery -W clippy::pedantic
```

- Running the [main CI checks](./.github/workflows/main.yml) locally:
```bash
nix-build -A ci
Expand Down

0 comments on commit b32aaea

Please sign in to comment.