From f4439bf4ccdfbcc6bfb85583073d78cf45693af6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20=C5=81askawiec?= Date: Tue, 21 May 2024 14:58:10 +0200 Subject: [PATCH] CLOUDP-212060 Document linting rules --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 95bf400aa..ecbdcb079 100644 --- a/README.md +++ b/README.md @@ -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.