From 1dd548eb2bd6dc22406d9491f3f4c6a80a41fec7 Mon Sep 17 00:00:00 2001 From: Ken Matsui <26405363+ken-matsui@users.noreply.github.com> Date: Sun, 27 Feb 2022 19:52:20 +0900 Subject: [PATCH] fix(docs): add information about clippy lints (#1126) --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f98110c96..6d6cde032 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,6 +68,13 @@ Once you do, in the repository root: To re-run the tests after you've changed something in the code base, be sure to repeat steps 2 and 3. +## How we treat clippy lints + +We currently use clippy in [GitHub Actions](https://github.com/zellij-org/zellij/blob/main/.github/workflows/rust.yml) with the default settings that report only [`clippy::correctness`](https://github.com/rust-lang/rust-clippy#readme) as errors and other lints as warnings because Zellij is still unstable. This means that all warnings can be ignored depending on the situation at that time, even though they are also helpful to keep the code quality. +Since we just cannot afford to manage them, we are always welcome to fix them! + +Here is [the detailed discussion](https://github.com/zellij-org/zellij/pull/1090) if you want to see it. + ## Looking for something to work on? If you are new contributor to `Zellij` going through