Skip to content

Commit a1e9506

Browse files
authored
Merge pull request #19815 from github/quality-top-level-tags
Update query-metadata-style-guide.md
2 parents b62a6db + 8450c5b commit a1e9506

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/query-metadata-style-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,12 @@ When you tag a query like this, the associated CWE pages from [MITRE.org](https:
151151
152152
#### Quality query sub-category `@tags`
153153

154+
Each code quality related query should have **one** of these two "top-level" categories as a tag:
155+
154156
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
155157
* `@tags reliability`–for queries that detect issues that affect whether the code will perform as expected during execution.
156158

157-
Software quality doesn't have as universally-agreed categorization method as security issues like CWE, so we will do our own categorization instead of using tags like CWE.
158-
159-
We'll use two "top-level" categories of quality queries, with sub-categories beneath:
159+
In addition to the "top-level" categories, we will also add sub-categories to further group code quality related queries:
160160

161161
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
162162
* `@tags readability`–for queries that detect confusing patterns that make it harder for developers to read the code.

0 commit comments

Comments
 (0)