Skip to content

Commit 1c75c9d

Browse files
committed
Docs: Master -> main and Semmle/ql -> github/codeql everywhere
Also fix a reference to QL for Eclipse, and remove some incidental trailing whitespace
1 parent 0f637c5 commit 1c75c9d

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Please note that this project is released with a [Contributor Code of Conduct](C
88

99
## Adding a new query
1010

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.
1212
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.
1313

1414
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
1717

1818
2. **Format your code correctly**
1919

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).
2121

2222
3. **Make sure your query has the correct metadata**
2323

2424
Query metadata is used to identify your query and make sure the query results are displayed properly.
2525
The most important metadata to include are the `@name`, `@description`, and the `@kind`.
2626
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).
2828

2929
4. **Make sure the `select` statement is compatible with the query type**
3030

@@ -33,8 +33,8 @@ Follow the steps below to help other users understand what your query does, and
3333

3434
5. **Write a query help file**
3535

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).
3838

3939
6. **Maintain backwards compatibility**
4040

ql/docs/experimental.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Experimental queries and libraries may not be actively maintained as the standar
1717
- The query must have a `@name` and `@description` to explain its purpose.
1818
- The query must have a `@kind` and `@problem.severity` as required by CodeQL tools.
1919

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).
2121

2222
3. **Formatting**
2323

@@ -34,4 +34,4 @@ Experimental queries and libraries may not be actively maintained as the standar
3434

3535
## Non-requirements
3636

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

Comments
 (0)