Skip to content

Commit

Permalink
chore: List checks to be run prior to submitting a PR in `CONTRIBUTIN…
Browse files Browse the repository at this point in the history
…G.md` (vectordotdev#19118)

* Add other CI jobs to CONTRIBUTING.md

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

* Mention cargo fmt

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

* Link to clippy

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

* Make checks copy pasteable

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

* Reduce line length

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

* Remove urls

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>

---------

Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
  • Loading branch information
StephenWakely authored and AndrooTheChen committed Sep 23, 2024
1 parent b3bcaca commit 275a701
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,27 @@ Integration tests are not run by default when running
`cargo vdev test`. Instead, they are accessible via the integration subcommand (example:
`cargo vdev int test aws` runs aws-related integration tests). You can find the list of available integration tests using `cargo vdev int show`. Integration tests require docker or podman to run.

### Running other checks

There are other checks that are run by CI before the PR can be merged. These should be run locally
first to ensure they pass.

```sh
# Run the Clippy linter to catch common mistakes.
cargo vdev check rust
# Ensure all code is properly formatted. Code can be run through `rustfmt` using `cargo fmt` to ensure it is properly formatted.
cargo vdev check fmt
# Ensure the internal metrics that Vector emits conform to standards.
cargo vdev check events
# Ensure the `LICENSE-3rdparty.csv` file is up to date with the licenses each of Vector's dependencies are published under.
cargo vdev check licenses
# Vector's documentation for each component is generated from the comments attached to the Component structs and members.
# Running this ensures that the generated docs are up to date.
make check-component-docs
# Generate the code documentation for the Vector project.
# Run this to ensure the docs can be generated without errors (warnings are acceptable at the minute).
cd rust-doc && make docs
```

### Deprecations

Expand Down

0 comments on commit 275a701

Please sign in to comment.