Skip to content

Commit 2ae590b

Browse files
committed
update contributing guide with instructions to format
1 parent 92cd4c4 commit 2ae590b

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,18 @@ We also recommend that you share in your description:
7878
If at any point you have a question or need assistance with your pull request, feel free to mention a project member!
7979
We're always happy to help contributors with their pull requests.
8080

81+
## Code Formatting
82+
83+
All Rust code must be formatted with `rustfmt` using the project's configuration in `rustfmt.toml`. You can format your
84+
code locally by running:
85+
86+
```bash
87+
cargo +nightly fmt --all
88+
```
89+
90+
If you'd like CI to automatically format your code and commit the changes to your PR, add the `commit-rustfmt-changes`
91+
label to your pull request. This will trigger an automatic formatting commit if any changes are needed.
92+
8193
## Commit Message Guidelines
8294

8395
This project uses [Conventional Commits](https://www.conventionalcommits.org/) for commit messages and pull request titles.

0 commit comments

Comments
 (0)