Update query-metadata-style-guide.md #19815
Open
+3
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
clarifying usage of top level tags
There was a problem hiding this comment.
Pull Request Overview
Clarifies the use of top-level @tags for code quality queries and introduces sub-categories for finer grouping.
- Adds instruction to assign exactly one top-level tag (
maintainabilityorreliability) - Removes outdated bullets and updates phrasing around sub-categories
- Begins listing sub-categories (currently for maintainability)
Comments suppressed due to low confidence (2)
docs/query-metadata-style-guide.md:161
- This bullet duplicates the top-level
maintainabilitytag under sub-categories. Consider replacing it with actual sub-categories (e.g.,readability,complexity) rather than repeating the top-level tag.
* `@tags maintainability`–for queries that detect patterns that make it harder for developers to make changes to the code.
docs/query-metadata-style-guide.md:159
- [nitpick] Sub-categories are shown only for
maintainability; consider adding parallel sub-categories forreliabilityto maintain consistency.
In addition to the "top-level" categories, we will also add sub-categories to further group code quality related queries:
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
clarifying usage of top level tags