@@ -8,9 +8,9 @@ something. We appreciate any sort of contributions, and don't want a wall of rul
8
8
9
9
Clippy welcomes contributions from everyone. There are many ways to contribute to Clippy and the following document
10
10
explains how you can contribute and how to get started. If you have any questions about contributing or need help with
11
- anything, feel free to ask questions on issues or visit the ` #clippy ` on [ Discord] ( https://discord.gg/rust-lang ) .
11
+ anything, feel free to ask questions on issues or visit the ` #clippy ` on [ Discord] .
12
12
13
- All contributors are expected to follow the [ Rust Code of Conduct] ( http://www.rust-lang.org/conduct.html ) .
13
+ All contributors are expected to follow the [ Rust Code of Conduct] .
14
14
15
15
* [ Getting started] ( #getting-started )
16
16
* [ Finding something to fix/improve] ( #finding-something-to-fiximprove )
@@ -21,6 +21,9 @@ All contributors are expected to follow the [Rust Code of Conduct](http://www.ru
21
21
* [ Bors and Homu] ( #bors-and-homu )
22
22
* [ Contributions] ( #contributions )
23
23
24
+ [ Discord ] : https://discord.gg/rust-lang
25
+ [ Rust Code of Conduct ] : https://www.rust-lang.org/policies/code-of-conduct
26
+
24
27
## Getting started
25
28
26
29
High level approach:
@@ -35,51 +38,57 @@ High level approach:
35
38
36
39
All issues on Clippy are mentored, if you want help with a bug just ask @Manishearth , @llogiq , @mcarton or @oli-obk .
37
40
38
- Some issues are easier than others. The [ ` good first issue ` ] ( https://github.com/rust-lang/rust-clippy/labels/good%20first%20issue )
39
- label can be used to find the easy issues. If you want to work on an issue, please leave a comment
40
- so that we can assign it to you!
41
+ Some issues are easier than others. The [ ` good first issue ` ] label can be used to find the easy issues.
42
+ If you want to work on an issue, please leave a comment so that we can assign it to you!
41
43
42
- There are also some abandoned PRs, marked with
43
- [ ` S-inactive-closed ` ] ( https://github.com/rust-lang/rust-clippy/pulls?q=is%3Aclosed+label%3AS-inactive-closed ) .
44
+ There are also some abandoned PRs, marked with [ ` S-inactive-closed ` ] .
44
45
Pretty often these PRs are nearly completed and just need some extra steps
45
46
(formatting, addressing review comments, ...) to be merged. If you want to
46
47
complete such a PR, please leave a comment in the PR and open a new one based
47
48
on it.
48
49
49
- Issues marked [ ` T-AST ` ] ( https://github.com/rust-lang/rust-clippy/labels/T-AST ) involve simple
50
- matching of the syntax tree structure, and are generally easier than
51
- [ ` T-middle ` ] ( https://github.com/rust-lang/rust-clippy/labels/T-middle ) issues, which involve types
50
+ Issues marked [ ` T-AST ` ] involve simple matching of the syntax tree structure,
51
+ and are generally easier than [ ` T-middle ` ] issues, which involve types
52
52
and resolved paths.
53
53
54
- [ ` T-AST ` ] ( https://github.com/rust-lang/rust-clippy/labels/T-AST ) issues will generally need you to match against a
55
- predefined syntax structure. To figure out how this syntax structure is encoded in the AST, it is recommended to run
56
- ` rustc -Z ast-json ` on an example of the structure and compare with the [ nodes in the AST
57
- docs] . Usually the lint will end up to be a nested series of matches and ifs, [ like
58
- so] ( https://github.com/rust-lang/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34 ) .
54
+ [ ` T-AST ` ] issues will generally need you to match against a predefined syntax structure.
55
+ To figure out how this syntax structure is encoded in the AST, it is recommended to run
56
+ ` rustc -Z ast-json ` on an example of the structure and compare with the [ nodes in the AST docs] .
57
+ Usually the lint will end up to be a nested series of matches and ifs, [ like so] .
59
58
60
- [ ` E-medium ` ] ( https://github.com/rust-lang/rust-clippy/labels/E-medium ) issues are generally
61
- pretty easy too, though it's recommended you work on an E-easy issue first. They are mostly classified
62
- as ` E-medium ` , since they might be somewhat involved code wise, but not difficult per-se.
59
+ [ ` E-medium ` ] issues are generally pretty easy too, though it's recommended you work on an E-easy issue first.
60
+ They are mostly classified as [ ` E-medium ` ] , since they might be somewhat involved code wise,
61
+ but not difficult per-se.
63
62
64
- [ ` T-middle ` ] ( https://github.com/rust-lang/rust-clippy/labels/T-middle ) issues can
65
- be more involved and require verifying types. The
66
- [ ` ty ` ] ( https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty ) module contains a
63
+ [ ` T-middle ` ] issues can be more involved and require verifying types. The [ ` ty ` ] module contains a
67
64
lot of methods that are useful, though one of the most useful would be ` expr_ty ` (gives the type of
68
65
an AST expression). ` match_def_path() ` in Clippy's ` utils ` module can also be useful.
69
66
67
+ [ `good first issue` ] : https://github.com/rust-lang/rust-clippy/labels/good%20first%20issue
68
+ [ `S-inactive-closed` ] : https://github.com/rust-lang/rust-clippy/pulls?q=is%3Aclosed+label%3AS-inactive-closed
69
+ [ `T-AST` ] : https://github.com/rust-lang/rust-clippy/labels/T-AST
70
+ [ `T-middle` ] : https://github.com/rust-lang/rust-clippy/labels/T-middle
71
+ [ `E-medium` ] : https://github.com/rust-lang/rust-clippy/labels/E-medium
72
+ [ `ty` ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc/ty
70
73
[ nodes in the AST docs ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_ast/ast/
74
+ [ like so ] : https://github.com/rust-lang/rust-clippy/blob/de5ccdfab68a5e37689f3c950ed1532ba9d652a0/src/misc.rs#L34
71
75
72
76
## Writing code
73
77
74
- Have a look at the [ docs for writing lints] ( doc/adding_lints.md ) for more details. [ Llogiq's blog post on
75
- lints] ( https://llogiq.github.io/2015/06/04/workflows.html ) is also a nice primer to lint-writing, though it does get
76
- into advanced stuff and may be a bit outdated.
78
+ Have a look at the [ docs for writing lints] [ adding_lints ] for more details. [ Llogiq's blog post on lints]
79
+ is also a nice primer to lint-writing, though it does get into advanced stuff and may be a bit outdated.
77
80
78
81
If you want to add a new lint or change existing ones apart from bugfixing, it's
79
82
also a good idea to give the [ stability guarantees] [ rfc_stability ] and
80
83
[ lint categories] [ rfc_lint_cats ] sections of the [ Clippy 1.0 RFC] [ clippy_rfc ] a
81
84
quick read.
82
85
86
+ [ adding_lints ] : https://github.com/rust-lang/rust-clippy/blob/master/doc/adding_lints.md
87
+ [ Llogiq's blog post on lints ] : https://llogiq.github.io/2015/06/04/workflows.html
88
+ [ clippy_rfc ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md
89
+ [ rfc_stability ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
90
+ [ rfc_lint_cats ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories
91
+
83
92
## How Clippy works
84
93
85
94
[ ` clippy_lints/src/lib.rs ` ] [ lint_crate_entry ] imports all the different lint modules and registers in the [ ` LintStore ` ] .
@@ -131,13 +140,16 @@ The difference between `EarlyLintPass` and `LateLintPass` is that the methods of
131
140
AST information. The methods of the ` LateLintPass ` trait are executed after type checking and contain type information
132
141
via the ` LateContext ` parameter.
133
142
134
- That's why the ` else_if_without_else ` example uses the ` register_early_pass ` function. Because the [ actual lint
135
- logic] [ else_if_without_else ] does not depend on any type information.
136
-
137
- See also [ the adding lints doc] .
143
+ That's why the ` else_if_without_else ` example uses the ` register_early_pass ` function. Because the
144
+ [ actual lint logic] [ else_if_without_else ] does not depend on any type information.
138
145
139
- [ the adding lints doc ] : https://github.com/rust-lang/rust-clippy/blob/master/doc/adding_lints.md
146
+ [ lint_crate_entry ] : https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/lib.rs
147
+ [ else_if_without_else ] : https://github.com/rust-lang/rust-clippy/blob/4253aa7137cb7378acc96133c787e49a345c2b3c/clippy_lints/src/else_if_without_else.rs
140
148
[ `LintStore` ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html
149
+ [ reg_early_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_early_pass
150
+ [ reg_late_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_late_pass
151
+ [ early_lint_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html
152
+ [ late_lint_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.LateLintPass.html
141
153
142
154
## Fixing build failures caused by Rust
143
155
@@ -146,8 +158,8 @@ the times we have to adapt to the changes and only very rarely there's an actual
146
158
caused by Rust updates, can be a good way to learn about Rust internals.
147
159
148
160
In order to find out why Clippy does not work properly with a new Rust commit, you can use the [ rust-toolstate commit
149
- history] [ toolstate_commit_history ] . You will then have to look for the last commit that contains
150
- ` test-pass -> build-fail ` or ` test-pass ` -> ` test-fail ` for the ` clippy-driver ` component.
161
+ history] [ toolstate_commit_history ] . You will then have to look for the last commit that contains
162
+ ` test-pass -> build-fail ` or ` test-pass -> test-fail ` for the ` clippy-driver ` component.
151
163
[ Here] [ toolstate_commit ] is an example.
152
164
153
165
The commit message contains a link to the PR. The PRs are usually small enough to discover the breaking API change and
@@ -178,6 +190,12 @@ git commit -m "Update Clippy"
178
190
# Open a PR in rust-lang/rust
179
191
```
180
192
193
+ [ rustup_component_history ] : https://rust-lang.github.io/rustup-components-history
194
+ [ toolstate_commit_history ] : https://github.com/rust-lang-nursery/rust-toolstate/commits/master
195
+ [ toolstate_commit ] : https://github.com/rust-lang-nursery/rust-toolstate/commit/aad74d8294e198a7cf8ac81a91aebb7f3bbcf727
196
+ [ rtim ] : https://github.com/kennytm/rustup-toolchain-install-master
197
+ [ `rust-lang/rust` ] : https://github.com/rust-lang/rust
198
+
181
199
## Issue and PR triage
182
200
183
201
Clippy is following the [ Rust triage procedure] [ triage ] for issues and pull
@@ -202,34 +220,22 @@ You can find the Clippy bors queue [here][homu_queue].
202
220
If you have @bors permissions, you can find an overview of the available
203
221
commands [ here] [ homu_instructions ] .
204
222
223
+ [ triage ] : https://forge.rust-lang.org/triage-procedure.html
224
+ [ l-crash ] : https://github.com/rust-lang/rust-clippy/labels/L-crash%20%3Aboom%3A
225
+ [ l-bug ] : https://github.com/rust-lang/rust-clippy/labels/L-bug%20%3Abeetle%3A
226
+ [ homu ] : https://github.com/rust-lang/homu
227
+ [ homu_instructions ] : https://buildbot2.rust-lang.org/homu/
228
+ [ homu_queue ] : https://buildbot2.rust-lang.org/homu/queue/clippy
229
+
205
230
## Contributions
206
231
207
232
Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
208
233
be reviewed by a core contributor (someone with permission to land patches) and either landed in the
209
234
main tree or given feedback for changes that would be required.
210
235
211
- All code in this repository is under the [ Apache-2.0] ( https://www.apache.org/licenses/LICENSE-2.0 )
212
- or the [ MIT] ( https://opensource.org/licenses/MIT ) license.
236
+ All code in this repository is under the [ Apache-2.0] or the [ MIT] license.
213
237
214
238
<!-- adapted from https://github.com/servo/servo/blob/master/CONTRIBUTING.md -->
215
239
216
- [ lint_crate_entry ] : https://github.com/rust-lang/rust-clippy/blob/master/clippy_lints/src/lib.rs
217
- [ else_if_without_else ] : https://github.com/rust-lang/rust-clippy/blob/4253aa7137cb7378acc96133c787e49a345c2b3c/clippy_lints/src/else_if_without_else.rs
218
- [ reg_early_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_early_pass
219
- [ reg_late_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_late_pass
220
- [ early_lint_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.EarlyLintPass.html
221
- [ late_lint_pass ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/trait.LateLintPass.html
222
- [ toolstate_commit_history ] : https://github.com/rust-lang-nursery/rust-toolstate/commits/master
223
- [ toolstate_commit ] : https://github.com/rust-lang-nursery/rust-toolstate/commit/aad74d8294e198a7cf8ac81a91aebb7f3bbcf727
224
- [ rtim ] : https://github.com/kennytm/rustup-toolchain-install-master
225
- [ rustup_component_history ] : https://rust-lang.github.io/rustup-components-history
226
- [ clippy_rfc ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md
227
- [ rfc_stability ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
228
- [ rfc_lint_cats ] : https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories
229
- [ triage ] : https://forge.rust-lang.org/triage-procedure.html
230
- [ l-crash ] : https://github.com/rust-lang/rust-clippy/labels/L-crash%20%3Aboom%3A
231
- [ l-bug ] : https://github.com/rust-lang/rust-clippy/labels/L-bug%20%3Abeetle%3A
232
- [ homu ] : https://github.com/rust-lang/homu
233
- [ homu_instructions ] : https://buildbot2.rust-lang.org/homu/
234
- [ homu_queue ] : https://buildbot2.rust-lang.org/homu/queue/clippy
235
- [ `rust-lang/rust` ] : https://github.com/rust-lang/rust
240
+ [ Apache-2.0 ] : https://www.apache.org/licenses/LICENSE-2.0
241
+ [ MIT ] : https://opensource.org/licenses/MIT
0 commit comments