From 976d2980b2d69059aa22e7ad16018387e39da344 Mon Sep 17 00:00:00 2001 From: Kristin Laemmert Date: Mon, 23 Mar 2020 15:48:31 -0400 Subject: [PATCH] docs/contributing: add note about codecov (#24434) --- .github/CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3c88c4cb1..5fde5a7b7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -268,3 +268,13 @@ promptly to pull requests, particularly if they do not relate to an existing GitHub issue where the Terraform team has already participated. We _are_ grateful for all contributions however, and will give feedback on pull requests as soon as we're able. + +### PR Checks + +The following checks run when a PR is opened: + +* Contributor License Agreement (CLA): If this is your first contribution to Terraform you will be asked to sign the CLA. +* Tests: tests include unit tests and acceptance tests, and all tests must pass before a PR can be merged. +* Test Coverage Report: We use [codecov](https://codecov.io/) to check both overall test coverage, and patch coverage. + +-> **Note:** We are still deciding on the right targets for our code coverage check. A failure in `codecov` does not necessarily mean that your PR will not be approved or merged.