diff options
| author | Ken Matsui <26405363+ken-matsui@users.noreply.github.com> | 2022-02-27 19:52:20 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-27 11:52:20 +0100 |
| commit | 1dd548eb2bd6dc22406d9491f3f4c6a80a41fec7 (patch) | |
| tree | aa23704437b52ba34a021e9fbcfc9135d2dafb04 | |
| parent | fix(ci): use the `clippy-check` action (#1122) (diff) | |
| download | sl0ppij-1dd548eb2bd6dc22406d9491f3f4c6a80a41fec7.tar.gz sl0ppij-1dd548eb2bd6dc22406d9491f3f4c6a80a41fec7.tar.xz sl0ppij-1dd548eb2bd6dc22406d9491f3f4c6a80a41fec7.zip | |
fix(docs): add information about clippy lints (#1126)
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f98110c9..6d6cde03 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 |