zellij-org/zellij
1
1
Fork 0
mirror of https://github.com/zellij-org/zellij.git synced 2024-12-26 18:55:26 +03:00
Code Issues Projects Releases Wiki Activity

fix(docs): add information about clippy lints (#1126)

Browse Source
This commit is contained in:
Ken Matsui 2022-02-27 19:52:20 +09:00 committed by GitHub
parent 01f7f4f3d2
commit 1dd548eb2b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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