Skip to content

Commit

Permalink
CLOUDP-212060 Document linting rules
Browse files Browse the repository at this point in the history
  • Loading branch information
slaskawi committed May 21, 2024
1 parent a8a30ff commit f4439bf
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ Please file issues before filing PRs. For PRs to be accepted, contributors must

Reviewers, please ensure that the CLA has been signed by referring to [the contributors tool](https://contributors.corp.mongodb.com/) (internal link).

## Linting

This project uses the following linters upon every Pull Request:

* `Black` is a tool that verifies if Python code is properly formatted
* `MyPy` is a Static Type Checker for Python
* `Kube-linter` is a tool that verified if all Kubernetes YAML manifests are formatted correctly
* `Go vet` A built-in Go static checker
* `Snyk` The vulnerability scanner

## License

Please see the [LICENSE](LICENSE.md) file.

0 comments on commit f4439bf

Please sign in to comment.