Skip to content

Commit

Permalink
Add running tests section in CONTRIBUTING guide (#958)
Browse files Browse the repository at this point in the history
  • Loading branch information
charisk authored Jan 9, 2024
1 parent 4bc74dd commit 520fcae
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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 <title>`.
- 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
Expand Down

0 comments on commit 520fcae

Please sign in to comment.