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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to QL
1
+
# Contributing to CodeQL
2
2
3
3
We welcome contributions to our standard library and standard checks. Got an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request!
4
4
@@ -9,13 +9,13 @@ Before we accept your pull request, we require that you have agreed to our Contr
9
9
If you have an idea for a query that you would like to share with other Semmle users, please open a pull request to add it to this repository.
10
10
Follow the steps below to help other users understand what your query does, and to ensure that your query is consistent with the other Semmle queries.
11
11
12
-
1.**Consult the QL documentation for query writers**
12
+
1.**Consult the documentation for query writers**
13
13
14
-
There is lots of useful documentation to help you write QL, 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).
14
+
There is lots of useful documentation to help you write queries, ranging from information about query file structure to tutorials for specific target languages. For more information on the documentation available, see [Writing CodeQL queries](https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html) on [help.semmle.com](https://help.semmle.com).
15
15
16
-
2.**Format your QL correctly**
16
+
2.**Format your code correctly**
17
17
18
-
All of Semmle's standard QL queries and libraries are uniformly formatted for clarity and consistency, so we strongly recommend that all QL contributions follow the same formatting guidelines. If you use QL for Eclipse, 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).
18
+
All of Semmle's standard 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 QL for Eclipse, 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 [CodeQL style guide](https://github.com/Semmle/ql/blob/master/docs/ql-style-guide.md).
19
19
20
20
3.**Make sure your query has the correct metadata**
21
21
@@ -29,7 +29,7 @@ Follow the steps below to help other users understand what your query does, and
29
29
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 QL for Eclipse.
30
30
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.
31
31
32
-
5.**Save your query in a `.ql` file in correct language directory in this repository**
32
+
5.**Save your query in a `.ql` file in the correct language directory in this repository**
33
33
34
34
There are five language-specific directories in this repository:
35
35
@@ -54,7 +54,7 @@ repositories, which might be made public. We might also use this information
54
54
to contact you in relation to your contributions, as well as in the
55
55
normal course of software development. We also store records of your
56
56
CLA agreements. Under GDPR legislation, we do this
57
-
on the basis of our legitimate interest in creating the QL product.
57
+
on the basis of our legitimate interest in creating the CodeQL product.
58
58
59
59
Please do get in touch ([email protected]) if you have any questions about
This open source repository contains the standard QL libraries and queries that power [LGTM](https://lgtm.com), and the other products that [Semmle](https://semmle.com) makes available to its customers worldwide.
3
+
This open source repository contains the standard CodeQL libraries and queries that power [LGTM](https://lgtm.com), and the other products that [Semmle](https://semmle.com) makes available to its customers worldwide.
4
4
5
-
## How do I learn QL and run queries?
5
+
## How do I learn CodeQL and run queries?
6
6
7
-
There is [extensive documentation](https://help.semmle.com/QL/learn-ql/) on getting started with writing QL.
7
+
There is [extensive documentation](https://help.semmle.com/QL/learn-ql/) on getting started with writing CodeQL.
8
8
You can use the [interactive query console](https://lgtm.com/help/lgtm/using-query-console) on LGTM.com or the [QL for Eclipse](https://lgtm.com/help/lgtm/running-queries-ide) plugin to try out your queries on any open-source project that's currently being analyzed.
9
9
10
10
## Contributing
11
11
12
-
We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/Semmle/ql/tree/master/docs) to learn how to format your QL for consistency and clarity, how to write query metadata, and how to write query help documentation for your query.
12
+
We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/Semmle/ql/tree/master/docs) to learn how to format your code for consistency and clarity, how to write query metadata, and how to write query help documentation for your query.
13
13
14
14
## License
15
15
16
-
The QL queries in this repository are licensed under [Apache License 2.0](LICENSE) by [Semmle](https://semmle.com).
16
+
The code in this repository is licensed under [Apache License 2.0](LICENSE) by [Semmle](https://semmle.com).
0 commit comments