chore(dev): add cargo commands to PR template (#22159)

* chore(dev): add cargo commands to PR template * address Jesse's review points
vectordotdev · Jan 10, 2025 · 3e3614e · 3e3614e
1 parent a976987
commit 3e3614e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -43,6 +43,12 @@ Providing this information upfront will facilitate a smoother review process. --
 
 ## Checklist
 - [ ] Please read our [Vector contributor resources](https://github.com/vectordotdev/vector/tree/master/docs#getting-started).
+  - `make check-all` is a good command to run locally. This check is
+    defined [here](https://github.com/vectordotdev/vector/blob/1ef01aeeef592c21d32ba4d663e199f0608f615b/Makefile#L450-L454). Some of these
+    checks might not be relevant to your PR. For Rust changes, at the very least you should run:
+    - `cargo fmt --all`
+    - `cargo clippy --workspace --all-targets -- -D warnings`
+    - `cargo nextest run --workspace` (alternatively, you can run `cargo test --all`)
 - [ ] If this PR introduces changes Vector dependencies (modifies `Cargo.lock`), please
   run `dd-rust-license-tool write` to regenerate the [license inventory](https://github.com/vectordotdev/vrl/blob/main/LICENSE-3rdparty.csv) and commit the changes (if any). More details [here](https://crates.io/crates/dd-rust-license-tool).