Skip to content

Commit 11c4a63

Browse files
committed
Quality tags: Clarify the quality sub-category tagging policy.
1 parent aefd941 commit 11c4a63

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/query-metadata-style-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Each code quality related query should have **one** of these two "top-level" cat
157157
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
158158
* `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution.
159159

160-
In addition to the "top-level" categories, we will also add sub-categories to further group code quality related queries:
160+
In addition to the "top-level" categories, we may also add sub-categories to further group code quality related queries:
161161

162162
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
163163
* `@tags readability`–for queries that detect confusing patterns that make it harder for developers to read the code.
@@ -171,6 +171,7 @@ In addition to the "top-level" categories, we will also add sub-categories to fu
171171
* `@tags concurrency`-for queries that detect concurrency related issues such as race conditions, deadlocks, thread safety, etc
172172
* `@tags error-handling`-for queries that detect issues related to unsafe error handling such as uncaught exceptions, etc
173173

174+
You may use sub-categories from both top-level categories on the same query. However, if you only use sub-categories from a single top-level category, then you must also tag the query with that top-level category.
174175

175176
There are also more specific `@tags` that can be added. See, the following pages for examples of the low-level tags:
176177

0 commit comments

Comments
 (0)