Skip to content

Commit 5ded9b3

Browse files
authored
doc: Add comment about local clippy run before submitting a pull request (#1961)
1 parent 2dd6ca2 commit 5ded9b3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/source/contributor-guide/development.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,12 @@ It is possible to debug both native and JVM code concurrently as described in th
161161

162162
Comet uses `cargo fmt`, [Scalafix](https://github.com/scalacenter/scalafix) and [Spotless](https://github.com/diffplug/spotless/tree/main/plugin-maven) to
163163
automatically format the code. Before submitting a pull request, you can simply run `make format` to format the code.
164+
165+
Additionally, it's strongly recommended to run Clippy locally to catch potential issues before the CI/CD pipeline does. You can run the same Clippy checks used in CI/CD with:
166+
167+
```bash
168+
cd native
169+
cargo clippy --color=never --all-targets --workspace -- -D warnings
170+
```
171+
172+
Make sure to resolve any Clippy warnings before submitting your pull request, as the CI/CD pipeline will fail if warnings are present.

0 commit comments

Comments
 (0)