-
Notifications
You must be signed in to change notification settings - Fork 30
Introduce qlty #199
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
Introduce qlty #199
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @Umekawa, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on integrating the qlty
action into the project to improve code quality and coverage monitoring. The changes involve adding a new gem for JSON-formatted coverage reports, reconfiguring the existing SimpleCov setup to support multiple output formats, and updating the README with new badges to visually represent the project's maintainability and code coverage status. This enhancement aims to provide better insights into the codebase's health and facilitate continuous quality improvement.
Highlights
- Introduction of qlty Action: This pull request integrates the
qlty
action into the project, enabling enhanced code quality and coverage reporting. This is achieved by introducing new tools and configurations to generate and display relevant metrics. - Dependency Update: simplecov_json_formatter: The
simplecov_json_formatter
gem has been added to theGemfile
. This new dependency allows SimpleCov to output code coverage results in a machine-readable JSON format, which is crucial for integration with external tools likeqlty
. - Code Coverage Reporting Configuration: The
spec/spec_helper.rb
file has been updated to configure SimpleCov to use aMultiFormatter
. This setup ensures that coverage reports are generated in both JSON (forqlty
integration) and HTML (for human readability) formats. Additionally, a filter was added to exclude thespec/
directory itself from coverage calculations. - README Badges for Quality Metrics: Two new badges have been added to the
README.md
: 'Maintainability' and 'Code Coverage'. These badges dynamically display the project's quality and coverage status as reported byqlty.sh
, providing a quick visual overview of the project's health.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Warning Gemini encountered an error creating the review. You can try again by commenting |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.
What
How
Why
REF