From 4173de7140e8b7b1b54e210eb7fd403b0d1f2cf9 Mon Sep 17 00:00:00 2001 From: Haroen Viaene Date: Thu, 24 Nov 2022 10:20:02 +0100 Subject: [PATCH] docs(e2e): mention usage in root contributing --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1d65f0fd38..eae79e7cd44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -171,6 +171,24 @@ To run the test continuously based on what you changed (useful when developing o yarn test --watch ``` +### End-to-end tests + +End-to-end tests are defined by the [tests/e2e](./tests/e2e/README.md) project. + +To run them locally: + +```sh +yarn test:e2e:local +``` + +To run them on saucelabs, with credentials as `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variable: + +```sh +yarn test:e2e:saucelabs +``` + +More info, including how to write the tests, can be found in its [CONTRIBUTING](./tests/e2e/CONTRIBUTING.md) and [README](./tests/e2e/README.md) files. + ### Type checks Type checks ensure code is correctly typed both for code quality and TypeScript compatibility.