Skip to content

Ruby: Update quality tags. #19793

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.

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
merged 2 commits into from
Jun 17, 2025
Merged

Conversation

michaelnebel
Copy link
Contributor

No description provided.

@michaelnebel michaelnebel marked this pull request as ready for review June 17, 2025 11:18
@Copilot Copilot AI review requested due to automatic review settings June 17, 2025 11:18
@michaelnebel michaelnebel requested a review from a team as a code owner June 17, 2025 11:18
Copy link
Contributor

@Copilot 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

This PR updates the metadata tags for two Ruby QL queries to better align with the style guide and records the changes in the project documentation.

  • Reorder and add the useless-code tag to the DeadStoreOfLocal.ql query
  • Reorder and add the reliability tag to the DatabaseQueryInLoop.ql query
  • Document both tag updates in 2025-06-17-tagging.md

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
ruby/ql/src/queries/variables/DeadStoreOfLocal.ql Reordered @tags list and added useless-code
ruby/ql/src/queries/performance/DatabaseQueryInLoop.ql Reordered @tags list and added reliability
ruby/ql/src/2025-06-17-tagging.md Added entry describing the updated metadata tags
Comments suppressed due to low confidence (1)

ruby/ql/src/2025-06-17-tagging.md:4

  • [nitpick] It may be helpful to list each query and its specific tag changes (e.g., old vs. new tags) for clearer context and future reference.
* Update query metadata tags for `rb/database-query-in-loop` and `rb/useless-assignment-to-local` to align with the established

Comment on lines +8 to 11
* @tags quality
* maintainability
* useless-code
* external/cwe/cwe-563
Copy link
Preview

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

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

[nitpick] Consider ordering the tags either alphabetically or according to the style guide’s recommended sequence for readability and consistency.

Suggested change
* @tags quality
* maintainability
* useless-code
* external/cwe/cwe-563
* @tags external/cwe/cwe-563
* maintainability
* quality
* useless-code

Copilot uses AI. Check for mistakes.

Comment on lines +8 to +10
* @tags quality
* reliability
* performance
Copy link
Preview

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

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

[nitpick] Similar to the first query, ensure the tag order follows the established style guide to keep all queries consistent.

Suggested change
* @tags quality
* reliability
* performance
* @tags performance
* quality
* reliability

Copilot uses AI. Check for mistakes.

Copy link
Contributor

@hvitved hvitved left a comment

Choose a reason for hiding this comment

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

We should turn those rules into a QL4QL query.

@michaelnebel
Copy link
Contributor Author

We should turn those rules into a QL4QL query.

Yes, that is a good idea. It is already on my list 😄

@michaelnebel michaelnebel merged commit 17cd58b into github:main Jun 17, 2025
23 checks passed
@michaelnebel michaelnebel deleted the ruby/qualitytags branch June 17, 2025 12:57
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.

2 participants