From 93e8c9efc9470fb17fb52b0a4fa17565ad22ee83 Mon Sep 17 00:00:00 2001 From: Philipp Hansch Date: Wed, 28 Nov 2018 08:11:28 +0100 Subject: [PATCH 1/2] Update docs in regards to the merged RFC --- CONTRIBUTING.md | 10 +++++++--- README.md | 2 -- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5bc9e99a2..cad6b93ca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,14 +63,15 @@ an AST expression). `match_def_path()` in Clippy's `utils` module can also be us ## Writing code -Compiling Clippy from scratch can take almost a minute or more depending on your machine. -However, since Rust 1.24.0 incremental compilation is enabled by default and compile times for small changes should be quick. - [Llogiq's blog post on lints](https://llogiq.github.io/2015/06/04/workflows.html) is a nice primer to lint-writing, though it does get into advanced stuff. Most lints consist of an implementation of `LintPass` with one or more of its default methods overridden. See the existing lints for examples of this. +If want to add a new lint or change existing ones apart from bugfixing, it's +also a good idea to give the [stability guaratees][rfc_stability] and +[lint categories][rfc_lint_cats] sections of the [Clippy 1.0 RFC][clippy_rfc] a +quick read. ### Author lint @@ -263,3 +264,6 @@ All code in this repository is under the [Mozilla Public License, 2.0](https://w [toolstate_commit]: https://github.com/rust-lang-nursery/rust-toolstate/commit/6ce0459f6bfa7c528ae1886492a3e0b5ef0ee547 [rtim]: https://github.com/kennytm/rustup-toolchain-install-master [rustup_component_history]: https://mexus.github.io/rustup-components-history +[clippy_rfc]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md +[rfc_stability]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#stability-guarantees +[rfc_lint_cats]: https://github.com/rust-lang/rfcs/blob/master/text/2476-clippy-uno.md#lint-audit-and-categories diff --git a/README.md b/README.md index 0cb1481c9..92bb45866 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -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. - # Clippy [![Build Status](https://travis-ci.org/rust-lang/rust-clippy.svg?branch=master)](https://travis-ci.org/rust-lang/rust-clippy) From 33c1e3c08c52eb32fa2eb80843fb42dddb9a1a06 Mon Sep 17 00:00:00 2001 From: Philipp Krones Date: Wed, 28 Nov 2018 14:39:25 +0100 Subject: [PATCH 2/2] Add missing word Co-Authored-By: phansch --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cad6b93ca..daaf1b37d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ to lint-writing, though it does get into advanced stuff. Most lints consist of a `LintPass` with one or more of its default methods overridden. See the existing lints for examples of this. -If want to add a new lint or change existing ones apart from bugfixing, it's +If you want to add a new lint or change existing ones apart from bugfixing, it's also a good idea to give the [stability guaratees][rfc_stability] and [lint categories][rfc_lint_cats] sections of the [Clippy 1.0 RFC][clippy_rfc] a quick read.