From 520fcae52ea4b7da9e56e9a857934f9532d99df4 Mon Sep 17 00:00:00 2001 From: Charis Kyriakou Date: Tue, 9 Jan 2024 11:25:49 +0000 Subject: [PATCH] Add running tests section in CONTRIBUTING guide (#958) --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 86163f9d..40cd2300 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,15 @@ # Development guide - Install the recommended extensions for automatic formatting on save. -- We use the [ava](https://github.com/avajs/ava) test runner. To run one or more specific test(s), use `npm run test -- -m `. -- The `codeql` executable must be on the path before running any tests. - All compiled artifacts should be checked in. - We recommend running `npm run watch` in the background to keep compiled artifacts up to date during development. +## Running tests + +We use the [ava](https://github.com/avajs/ava) test runner. To run one or more specific test(s), use `npm run test -- -m <title>`. + +The `codeql` executable must be on the path before running any tests. If you run `script/test` instad of `npm run test` it will set that up automatically. + # Generating sourcemaps In case you want to generate sourcemaps for tracing back a specific line in a stacktrace to the source code, you can