Skip to content

Commit 31a4675

Browse files
authored
CLOUDP-212060 Document linting rules (#1550)
1 parent a8a30ff commit 31a4675

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,16 @@ Please file issues before filing PRs. For PRs to be accepted, contributors must
6565

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

68+
## Linting
69+
70+
This project uses the following linters upon every Pull Request:
71+
72+
* `Black` is a tool that verifies if Python code is properly formatted
73+
* `MyPy` is a Static Type Checker for Python
74+
* `Kube-linter` is a tool that verified if all Kubernetes YAML manifests are formatted correctly
75+
* `Go vet` A built-in Go static checker
76+
* `Snyk` The vulnerability scanner
77+
6878
## License
6979

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

0 commit comments

Comments
 (0)