Skip to content

Commit 6388d69

Browse files
authored
Tidy up contributing docs (#952)
1 parent 6a9e64a commit 6388d69

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,16 @@
33
- Install the recommended extensions for automatic formatting on save.
44
- 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>`.
55
- The `codeql` executable must be on the path before running any tests.
6-
- All compiled artifacts and `node_modules` dependencies should be checked in.
6+
- All compiled artifacts should be checked in.
77
- We recommend running `npm run watch` in the background to keep compiled artifacts up to date during development.
8+
9+
# Generating sourcemaps
10+
11+
In case you want to generate sourcemaps for tracing back a specific line in a stacktrace to the source code, you can
12+
use the following command:
13+
14+
```shell
15+
CODEQL_VARIANT_ANALYSIS_ACTION_GENERATE_SOURCEMAPS=true npm run build
16+
```
17+
18+
The sourcemaps will be placed in the `dist` directory.

README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,3 @@
33
This action is used internally by GitHub's multi-repository variant analysis. It is not intended to be used directly.
44

55
If you want to use CodeQL to analyze your source code, please see the [CodeQL Action](https://github.com/github/codeql-action) and the [Code scanning documentation](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning).
6-
7-
### Generating sourcemaps
8-
9-
In case you want to generate sourcemaps for tracing back a specific line in a stacktrace to the source code, you can
10-
use the following command:
11-
12-
```shell
13-
CODEQL_VARIANT_ANALYSIS_ACTION_GENERATE_SOURCEMAPS=true npm run build
14-
```
15-
16-
The sourcemaps will be placed in the `dist` directory.

0 commit comments

Comments
 (0)