Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: List checks to be run prior to submitting a PR in CONTRIBUTING.md #19118

Merged
merged 6 commits into from
Nov 10, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,22 @@ 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.

- `cargo vdev check rust` - this runs the Clippy linter to catch common mistakes.
StephenWakely marked this conversation as resolved.
Show resolved Hide resolved
- `cargo vdev check fmt` - this ensures all code is properly formatted. Code can be run through
[`rustfmt`][urls.rustfmt] using `cargo fmt` to ensure it is properly formatted.
- `cargo vdev check events` - this ensures the internal metrics that Vector emits conform to standards.
- `cargo vdev check licenses` - ensures the `LICENSE-3rdparty.csv` file is up to date with the licenses
each of Vector's dependencies are published under. If this file needs updating, you can run
- `make check-component-docs` - 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.
- `cd rust-doc && make docs` - generates the code documentation for the Vector project. Run this to
ensure the docs can be generated without errors (warnings are acceptable at the minute).

### Deprecations

Expand Down Expand Up @@ -266,3 +282,4 @@ This is covered by the CLA.
[urls.new_issue]: https://github.com/vectordotdev/vector/issues/new
[urls.submit_pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork
[urls.vector_test_harness]: https://github.com/vectordotdev/vector-test-harness/
[urls.rustfmt]: https://github.com/rust-lang/rustfmt
Loading