Skip to content

Commit a03ce65

Browse files
authored
Merge pull request #3466 from phansch/clippy_rfc_readme
Update docs in regards to the merged RFC
2 parents ab5b75a + 33c1e3c commit a03ce65

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,15 @@ an AST expression). `match_def_path()` in Clippy's `utils` module can also be us
6363

6464
## Writing code
6565

66-
Compiling Clippy from scratch can take almost a minute or more depending on your machine.
67-
However, since Rust 1.24.0 incremental compilation is enabled by default and compile times for small changes should be quick.
68-
6966
[Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer
7067
to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of
7168
`LintPass` with one or more of its default methods overridden. See the existing lints for examples
7269
of this.
7370

71+
If you want to add a new lint or change existing ones apart from bugfixing, it's
72+
also a good idea to give the [stability guaratees][rfc_stability] and
73+
[lint categories][rfc_lint_cats] sections of the [Clippy 1.0 RFC][clippy_rfc] a
74+
quick read.
7475

7576
### Author lint
7677

@@ -263,3 +264,6 @@ All code in this repository is under the [Mozilla Public License, 2.0](https://w
263264
[toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547
264265
[rtim]: https://github.com/kennytm/rustup-toolchain-install-master
265266
[rustup_component_history]: https://mexus.github.io/rustup-components-history
267+
[clippy_rfc]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md
268+
[rfc_stability]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees
269+
[rfc_lint_cats]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
We are currently in the process of discussing Clippy 1.0 via the RFC process in https://github.com/rust-lang/rfcs/pull/2476 . The RFC's goal is to clarify policies around lint categorizations and the policy around which lints should be in the compiler and which lints should be in Clippy. Please leave your thoughts on the RFC PR.
2-
31
# Clippy
42

53
[![Build Status](https://travis-ci.org/rust-lang/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang/rust-clippy)

0 commit comments

Comments
 (0)