You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Please note that this project is released with a [Contributor Code of Conduct](C
8
8
9
9
## Adding a new query
10
10
11
-
If you have an idea for a query that you would like to share with other CodeQL users, please open a pull request to add it to this repository.
11
+
If you have an idea for a query that you would like to share with other CodeQL users, please open a pull request to add it to this repository.
12
12
Follow the steps below to help other users understand what your query does, and to ensure that your query is consistent with the other CodeQL queries.
13
13
14
14
1.**Consult the documentation for query writers**
@@ -17,14 +17,14 @@ Follow the steps below to help other users understand what your query does, and
17
17
18
18
2.**Format your code correctly**
19
19
20
-
All of the standard CodeQL queries and libraries are uniformly formatted for clarity and consistency, so we strongly recommend that all contributions follow the same formatting guidelines. If you use the CodeQL extension for Visual Studio Code, you can auto-format your query in the [QL editor](https://help.semmle.com/ql-for-eclipse/Content/WebHelp/ql-editor.html). For more information, see the [QL style guide](https://github.com/Semmle/ql/blob/master/docs/ql-style-guide.md).
20
+
All of the standard CodeQL queries and libraries are uniformly formatted for clarity and consistency, so we strongly recommend that all contributions follow the same formatting guidelines. If you use the CodeQL extension for Visual Studio Code, you can auto-format your query using the [Format Document command](https://help.semmle.com/codeql/codeql-for-vscode/procedures/about-codeql-for-vscode.html). For more information, see the [QL style guide](https://github.com/github/codeql/blob/main/docs/ql-style-guide.md).
21
21
22
22
3.**Make sure your query has the correct metadata**
23
23
24
24
Query metadata is used to identify your query and make sure the query results are displayed properly.
25
25
The most important metadata to include are the `@name`, `@description`, and the `@kind`.
26
26
Other metadata properties (`@precision`, `@severity`, and `@tags`) are usually added after the query has been reviewed by the maintainers.
27
-
For more information on writing query metadata, see the [Query metadata style guide](https://github.com/Semmle/ql/blob/master/docs/query-metadata-style-guide.md).
27
+
For more information on writing query metadata, see the [Query metadata style guide](https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md).
28
28
29
29
4.**Make sure the `select` statement is compatible with the query type**
30
30
@@ -33,8 +33,8 @@ Follow the steps below to help other users understand what your query does, and
33
33
34
34
5.**Write a query help file**
35
35
36
-
Query help files explain the purpose of your query to other users. Write your query help in a `.qhelp` file and save it in the same directory as your new query.
37
-
For more information on writing query help, see the [Query help style guide](https://github.com/Semmle/ql/blob/master/docs/query-help-style-guide.md).
36
+
Query help files explain the purpose of your query to other users. Write your query help in a `.qhelp` file and save it in the same directory as your new query.
37
+
For more information on writing query help, see the [Query help style guide](https://github.com/github/codeql/blob/main/docs/query-help-style-guide.md).
Copy file name to clipboardExpand all lines: ql/docs/experimental.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Experimental queries and libraries may not be actively maintained as the standar
17
17
- The query must have a `@name` and `@description` to explain its purpose.
18
18
- The query must have a `@kind` and `@problem.severity` as required by CodeQL tools.
19
19
20
-
For details, see the [guide on query metadata](https://github.com/github/codeql/blob/master/docs/query-metadata-style-guide.md).
20
+
For details, see the [guide on query metadata](https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md).
21
21
22
22
3.**Formatting**
23
23
@@ -34,4 +34,4 @@ Experimental queries and libraries may not be actively maintained as the standar
34
34
35
35
## Non-requirements
36
36
37
-
Other criteria typically required for our standard queries and libraries are not required for experimental queries and libraries. In particular, fully disciplined query [metadata](https://github.com/github/codeql/blob/master/docs/query-metadata-style-guide.md), query [help](https://github.com/github/codeql/blob/master/docs/query-help-style-guide.md), tests, a low false positive rate and performance tuning are not required (but nonetheless recommended).
37
+
Other criteria typically required for our standard queries and libraries are not required for experimental queries and libraries. In particular, fully disciplined query [metadata](https://github.com/github/codeql/blob/main/docs/query-metadata-style-guide.md), query [help](https://github.com/github/codeql/blob/main/docs/query-help-style-guide.md), tests, a low false positive rate and performance tuning are not required (but nonetheless recommended).
0 commit comments