Skip to content

Commit a95b87d

Browse files
committed
Update CONTRIBUTING guidelines
1 parent d8a19ec commit a95b87d

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,17 @@ Please note that this project is released with a [Contributor Code of Conduct](C
88

99
## Building and testing
1010

11+
See [Developer information](docs/HOWTO.md) for information on building the Ruby extractor. There is no need to rebuild the extractor if you are only developing queries.
12+
1113
1. Install the CodeQL CLI as described in [Getting started with the CodeQL CLI](https://codeql.github.com/docs/codeql-cli/getting-started-with-the-codeql-cli/).
1214

1315
2. Ensure that `<extraction-root>/codeql` is in your `PATH`.
1416

15-
3. Clone this repository into `<extraction-root>/codeql-go` and change to this directory.
16-
17-
4. To build, run `make`.
18-
19-
5. To run the full test suite, run `make test`. This will take approximately one hour.
17+
3. Clone this repository into `<extraction-root>/codeql-ruby` and change to this directory.
2018

21-
6. To run all tests in a directory and its subdirectories, run `codeql test run <directory>`, for example `codeql test run ql/test/query-tests/Security`.
19+
4. To run all tests in a directory and its subdirectories, run `codeql test run <directory>`, for example `codeql test run ql/test/query-tests/security`.
2220

23-
7. To run an individual test, run `codeql test run <filename>`, where `<filename>` is a `.ql` or `.qlref` file, for example `codeql test run ql/test/query-tests/Security/CWE-020/MissingRegexpAnchor/MissingRegexpAnchor.qlref`.
21+
6. To run an individual test, run `codeql test run <filename>`, where `<filename>` is a `.ql` or `.qlref` file, for example `codeql test run ql/test/query-tests/security/cwe-078/CommandInjection.qlref`.
2422

2523
## Adding a new query
2624

@@ -29,7 +27,7 @@ Follow the steps below to help other users understand what your query does, and
2927

3028
1. **Consult the documentation for query writers**
3129

32-
There is lots of useful documentation to help you write CodeQL queries, ranging from information about query file structure to language-specific tutorials. For more information on the documentation available, see [Writing QL queries](https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html) on [help.semmle.com](https://help.semmle.com).
30+
There is lots of useful documentation to help you write CodeQL queries, ranging from information about query file structure to language-specific tutorials. For more information on the documentation available, see [Writing CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/) and the [CodeQL documentation](https://codeql.github.com/docs).
3331

3432
2. **Format your code correctly**
3533

@@ -45,7 +43,7 @@ Follow the steps below to help other users understand what your query does, and
4543
4. **Make sure the `select` statement is compatible with the query type**
4644

4745
The `select` statement of your query must be compatible with the query type (determined by the `@kind` metadata property) for alert or path results to be displayed correctly in LGTM and Visual Studio Code.
48-
For more information on `select` statement format, see [Introduction to query files](https://help.semmle.com/QL/learn-ql/writing-queries/introduction-to-queries.html#select-clause) on help.semmle.com.
46+
For more information on `select` statement format, see [About CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/#select-clause) on the [CodeQL documentation](https://codeql.github.com/docs) site.
4947

5048
5. **Write a query help file**
5149

0 commit comments

Comments
 (0)