Skip to content

Commit 934fd9f

Browse files
author
james
committed
address geoffrey's comments and reword tags
1 parent 2ed648d commit 934fd9f

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/query-metadata-style-guide.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ The `@id` should consist of a short noun phrase that identifies the issue that t
6565
* `@id cs/command-line-injection`
6666
* `@id java/string-concatenation-in-loop`
6767

68+
Further terms can be added to the `@id` to group queries that, for example, highlight similar issues or are of particular relevance to a certain framework. For example:
69+
70+
* `@id js/angular-js/missing-explicit-injection`
71+
* `@id js/angular-js/duplicate-dependency`
72+
6873
Note, `@id` properties should be consistent for queries that highlight the same issue for different languages. For example, the following queries identify format strings that contain unsanitized input in Java and C++ code respectively:
6974

7075

@@ -103,8 +108,8 @@ The values of `@precision` and `@problem.severity` assigned to a query that is p
103108
The `@tags` property is used to define categories that the query relates to. Each query should belong to one (or more, if necessary) of the following four top-level categories:
104109

105110
* `@tags correctness`–for queries that detect incorrect program behavior.
106-
* `@tags maintainability`–for queries that detect patterns that make it hard for developers to make changes to the code.
107-
* `@tags readability`–for queries that detect confusing patterns that make it hard for developers to read the code.
111+
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
112+
* `@tags readability`–for queries that detect confusing patterns that make it harder for developers to read the code.
108113
* `@tags security`–for queries that detect security weaknesses. See below for further information.
109114

110115
There are also more specific `@tags` that can be specified. See, the following pages for more information on the low-level tags:

0 commit comments

Comments
 (0)