Skip to content

Commit bcccd3e

Browse files
committed
docs(dev-guide): move all mentions of cargo clippy to linting.md
1 parent 52ad0b0 commit bcccd3e

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

doc/dev-guide/src/index.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@
44
2. Create your feature branch: `git checkout -b my-new-feature`
55
3. Test it: `cargo test --features=test`
66
4. [Lint it!](linting.md)
7-
8-
> We use `cargo clippy` to ensure high-quality code and to enforce a set of best practices for Rust programming. However, not all lints provided by `cargo clippy` are relevant or applicable to our project.
9-
> We may choose to ignore some lints if they are unstable, experimental, or specific to our project.
10-
> If you are unsure about a lint, please ask us in the [rustup Discord channel](https://discord.com/channels/442252698964721669/463480252723888159).
11-
127
5. Commit your changes: `git commit -am 'Add some feature'`
138
6. Push to the branch: `git push origin my-new-feature`
149
7. Submit a pull request :D

doc/dev-guide/src/linting.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Linting
22

3+
We use `cargo clippy` to ensure high-quality code and to enforce a set of best practices for Rust programming. However, not all lints provided by `cargo clippy` are relevant or applicable to our project.
4+
We may choose to ignore some lints if they are unstable, experimental, or specific to our project.
5+
If you are unsure about a lint, please ask us in the [rustup Discord channel](https://discord.com/channels/442252698964721669/463480252723888159).
6+
37
## Manual linting
48

59
When checking the codebase with [`clippy`](https://doc.rust-lang.org/stable/clippy/index.html), it is recommended to use:

0 commit comments

Comments
 (0)