Skip to content

Ql4ql: Quality query tagging. #19931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaelnebel merged 10 commits into from
Jul 17, 2025
Merged

Ql4ql: Quality query tagging. #19931

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cce1774
Ql4Ql: Re-factor the ql/mising-security-metadata query.
michaelnebel Jun 30, 2025
c46b528
Ql4Ql: Add some quality tag testcases.
michaelnebel Jun 30, 2025
e00b535
Ql4Ql: Add a check for quality tag consistency.
michaelnebel Jun 30, 2025
60a1d02
Ql4Ql: Add MissingQualityMetadata test.
michaelnebel Jun 30, 2025
af1c4e0
Ql4Ql: Share the definition of TestFile between multiple tests.
michaelnebel Jul 1, 2025
f58064e
Ql4Ql: Address review comments.
michaelnebel Jul 2, 2025
b79e2dd
Ql4Ql: Add some more quality tag testcases.
michaelnebel Jul 3, 2025
f810e17
Ql4Ql: Address review comments and update expected test output.
michaelnebel Jul 3, 2025
aefd941
Java/Javascript: Fix violations.
michaelnebel Jul 3, 2025
11c4a63
Quality tags: Clarify the quality sub-category tagging policy.
michaelnebel Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Quality tags: Clarify the quality sub-category tagging policy.
  • Loading branch information
@michaelnebel
michaelnebel committed Jul 3, 2025
commit 11c4a638bc63f6ddc5861831967afa2073636672
3 changes: 2 additions & 1 deletion docs/query-metadata-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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 readability`–for queries that detect confusing patterns that make it harder for developers to read the code.
Expand All @@ -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 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:

Expand Down
Loading