Skip to content

Update query-metadata-style-guide.md#19815

Merged
jonjanego merged 1 commit intomainfrom
quality-top-level-tags
Jun 19, 2025
Merged

Update query-metadata-style-guide.md#19815
jonjanego merged 1 commit intomainfrom
quality-top-level-tags

Conversation

@jonjanego
Copy link
Copy Markdown
Member

clarifying usage of top level tags

clarifying usage of top level tags
Copilot AI review requested due to automatic review settings June 18, 2025 16:24
@jonjanego jonjanego requested a review from a team as a code owner June 18, 2025 16:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 (maintainability or reliability)
  • 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 maintainability tag 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 for reliability to maintain consistency.
In addition to the "top-level" categories, we will also add sub-categories to further group code quality related queries:

@jonjanego jonjanego merged commit a1e9506 into main Jun 19, 2025
6 checks passed
@jonjanego jonjanego deleted the quality-top-level-tags branch June 19, 2025 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants