Skip to content

Commit 7b56483

Browse files
committed
Add rustfmt instructions to CONTRIBUTING.md
1 parent d306b63 commit 7b56483

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,15 @@ Coding Conventions
120120
------------------
121121

122122
Use tabs. If you want to align lines, use spaces. Any desired alignment should
123-
display fine at any tab-length display setting.
123+
display fine at any tab-length display setting. We use `rustfmt` to establish
124+
uniform coding standards throughout the codebase. Please run
125+
126+
```bash
127+
./ci/rustfmt.sh
128+
```
129+
130+
before committing and pushing any changes, as compliance will also be checked
131+
and enforced by our CI scripts.
124132

125133
Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy) default
126134
linting

0 commit comments

Comments
 (0)