@@ -13,9 +13,9 @@ anything, feel free to ask questions on issues or visit the `#clippy` on [Zulip]
13
13
All contributors are expected to follow the [ Rust Code of Conduct] .
14
14
15
15
- [ Contributing to Clippy] ( #contributing-to-clippy )
16
- - [ Getting started ] ( #getting-started )
17
- - [ High level approach] ( #high-level-approach )
18
- - [ Finding something to fix/improve] ( #finding-something-to-fiximprove )
16
+ - [ The Clippy book ] ( #the-clippy-book )
17
+ - [ High level approach] ( #high-level-approach )
18
+ - [ Finding something to fix/improve] ( #finding-something-to-fiximprove )
19
19
- [ Writing code] ( #writing-code )
20
20
- [ Getting code-completion for rustc internals to work] ( #getting-code-completion-for-rustc-internals-to-work )
21
21
- [ IntelliJ Rust] ( #intellij-rust )
@@ -28,20 +28,24 @@ All contributors are expected to follow the [Rust Code of Conduct].
28
28
[ Zulip ] : https://rust-lang.zulipchat.com/#narrow/stream/clippy
29
29
[ Rust Code of Conduct ] : https://www.rust-lang.org/policies/code-of-conduct
30
30
31
- ## Getting started
31
+ ## The Clippy book
32
32
33
- ** Note: If this is your first time contributing to Clippy, you should
34
- first read the [ Basics docs ] ( doc/basics.md ) . **
33
+ If you're new to Clippy and don't know where to start the [ Clippy book ] includes
34
+ a developer guide and is a good place to start your journey.
35
35
36
- ### High level approach
36
+ <!-- FIXME: Link to the deployed book, once it is deployed through CI -->
37
+ [ Clippy book ] : book/src
38
+
39
+ ## High level approach
37
40
38
41
1 . Find something to fix/improve
39
42
2 . Change code (likely some file in ` clippy_lints/src/ ` )
40
- 3 . Follow the instructions in the [ Basics docs] ( doc/basics.md ) to get set up
43
+ 3 . Follow the instructions in the [ Basics docs] ( book/src/development/basics.md )
44
+ to get set up
41
45
4 . Run ` cargo test ` in the root directory and wiggle code until it passes
42
46
5 . Open a PR (also can be done after 2. if you run into problems)
43
47
44
- ### Finding something to fix/improve
48
+ ## Finding something to fix/improve
45
49
46
50
All issues on Clippy are mentored, if you want help simply ask @Manishearth , @flip1995 , @phansch
47
51
or @llogiq directly by mentioning them in the issue or over on [ Zulip] . This list may be out of date.
@@ -86,20 +90,6 @@ an AST expression). `match_def_path()` in Clippy's `utils` module can also be us
86
90
[ let chains ] : https://github.com/rust-lang/rust/pull/94927
87
91
[ nest-less ] : https://github.com/rust-lang/rust-clippy/blob/5e4f0922911536f80d9591180fa604229ac13939/clippy_lints/src/bit_mask.rs#L133-L159
88
92
89
- ## Writing code
90
-
91
- Have a look at the [ docs for writing lints] [ adding_lints ] for more details.
92
-
93
- If you want to add a new lint or change existing ones apart from bugfixing, it's
94
- also a good idea to give the [ stability guarantees] [ rfc_stability ] and
95
- [ lint categories] [ rfc_lint_cats ] sections of the [ Clippy 1.0 RFC] [ clippy_rfc ] a
96
- quick read.
97
-
98
- [ adding_lints ] : https://github.com/rust-lang/rust-clippy/blob/master/doc/adding_lints.md
99
- [ clippy_rfc ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md
100
- [ rfc_stability ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
101
- [ rfc_lint_cats ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories
102
-
103
93
## Getting code-completion for rustc internals to work
104
94
105
95
### IntelliJ Rust
0 commit comments