From 3b64270485802a5712161687b73c6fcf1f4c08ad Mon Sep 17 00:00:00 2001 From: Stephen Date: Mon, 7 Jun 2021 10:48:16 -0500 Subject: [PATCH] Update contributing doc with testing instructions (#3222) Signed-off-by: sirugh --- .github/CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1cc46ac387..35f419bf55 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -72,6 +72,23 @@ If you are unsure about anything, reach out to anyone in the Community Advisory To get your contribution accepted, you must sign [Adobe's Contributor License Agreement (CLA)](https://opensource.adobe.com/cla.html). You only need to sign the CLA once. +#### Testing your solution + +We require tests be provided with any contributions - please add or update tests +to ensure your changes are covered. We're happy to work with you and to provide +tests for your contributions in the event that you are unable to do so yourself. + +If you want to check test coverage locally, you can use the `--testPathPattern` +and `--collectCoverageFrom` Jest arguments. Otherwise, wait for the CI tooling +to report back in your PR on the test status/coverage. + +If you modified the `useCategoryTree` talon you would run the following command +to check tests and coverage: + +```sh +yarn test --testPathPattern="useCategoryTree" --collectCoverageFrom="**/useCategoryTree**" +``` + #### PR review process After you submit your PR, the Community Advisory Board will assign one or more reviewers to look over your solution and ensure quality and adherence to standards.