Skip to content

Commit 62fb745

Browse files
author
james
committed
docs: address review comments
1 parent 1f076ef commit 62fb745

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Follow the steps below to help other users understand what your query does, and
1111

1212
1. **Consult the QL documentation for query writers**
1313

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

1616
2. **Format your QL correctly**
1717

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

2020
3. **Make sure your query has the correct metadata**
2121

@@ -39,6 +39,7 @@ Follow the steps below to help other users understand what your query does, and
3939
* JavaScript: `ql/javascript/ql/src`
4040
* Python: `ql/python/ql/src`
4141

42+
Each language-specific directory contains further subdirectories that group queries based on their `@tags` properties or purpose. Make sure that you select the appropriate subdirectory for your new query, or create a new one if necessary.
4243

4344
6. **Write a query help file**
4445

0 commit comments

Comments
 (0)