hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Quality tags: Clarify the quality sub-category tagging policy.

Browse Source
This commit is contained in:
Michael Nebel
2025-07-03 12:19:41 +02:00
parent aefd941135
commit 11c4a638bc
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/query-metadata-style-guide.md
View File

@@ -157,7 +157,7 @@ Each code quality related query should have **one** of these two "top-level" cat
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code. * `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
* `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution. * `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution.
In addition to the "top-level" categories, we will also add sub-categories to further group code quality related queries: In addition to the "top-level" categories, we may also add sub-categories to further group code quality related queries:
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code. * `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
* `@tags readability`–for queries that detect confusing patterns that make it harder for developers to read the code. * `@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
* `@tags concurrency`-for queries that detect concurrency related issues such as race conditions, deadlocks, thread safety, etc * `@tags concurrency`-for queries that detect concurrency related issues such as race conditions, deadlocks, thread safety, etc
* `@tags error-handling`-for queries that detect issues related to unsafe error handling such as uncaught exceptions, etc * `@tags error-handling`-for queries that detect issues related to unsafe error handling such as uncaught exceptions, etc
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.
There are also more specific `@tags` that can be added. See, the following pages for examples of the low-level tags: There are also more specific `@tags` that can be added. See, the following pages for examples of the low-level tags: