Skip to content

Commit

Permalink
Suggest using more xtask commands
Browse files Browse the repository at this point in the history
  • Loading branch information
playfulFence committed Jul 9, 2024
1 parent 03aca3b commit f3e6a9e
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Ensuring the quality and reliability of `esp-hal` is a shared responsibility, an
Further steps that can (or should) be taken in testing:

* Using [xtask], build examples for the specified chip.
* Build the documentation if it has been modified using the `run-doc-test` command in [xtask].
* Build the documentation and run the doctests if they have been modified using the `build-documentation` and `run-doc-test` commands in [xtask].
* Run the [HIL] tests locally if changes have been made to them.

[xtask]: https://github.com/esp-rs/esp-hal/tree/main/xtask
Expand All @@ -105,7 +105,13 @@ We _strongly_ recommend that you format your code before committing to ensure co
To format all packages in the workspace, run the following command in a terminal from the root of the repository:

```shell
cargo xtask fmt-workspace
cargo xtask fmt-packages
```

We also recommend using the `lint-packages` subcommand, which uses `cargo clippy` and will lint the entire driver in order to catch common mistakes in the code.

```shell
cargo xtask lint-packages
```

This will use `rustfmt` to ensure that all source code is formatted correctly prior to committing.
Expand Down

0 comments on commit f3e6a9e

Please sign in to comment.