Skip to content

CLOUDP-212060 Document linting rules #1550

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 21, 2024
Merged

CLOUDP-212060 Document linting rules #1550

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
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.