Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add running tests section in CONTRIBUTING guide #958

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Add running tests section in CONTRIBUTING guide #958

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
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