Skip to content

docs(readme): add Codecov and SonarCloud quality badges#394

Closed
vitali87 wants to merge 1 commit intopr-split/pr-1from
pr-split/pr-2
Closed

docs(readme): add Codecov and SonarCloud quality badges#394
vitali87 wants to merge 1 commit intopr-split/pr-1from
pr-split/pr-2

Conversation

@vitali87
Copy link
Owner

Adds Codecov coverage badge and SonarCloud Quality Gate Status badge to the README, pointing to their respective dashboards for the project.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 enhances the project's README.md by integrating new badges for code quality and coverage. These additions provide immediate visual indicators of the project's health and link directly to detailed reports from Codecov and SonarCloud, improving transparency and accessibility of key development metrics.

Highlights

  • Code Coverage Badge: Added a Codecov badge to the README, linking to the project's code coverage dashboard.
  • Code Quality Badge: Included a SonarCloud Quality Gate Status badge in the README, providing a direct link to the project's quality metrics.
Changelog
  • README.md
    • Added Codecov coverage badge.
    • Added SonarCloud Quality Gate Status badge.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds Codecov and SonarCloud badges to the README.md file. My review includes a suggestion to use shields.io for generating these badges to ensure visual consistency with the other badges already present in the file.

Comment on lines +18 to +23
<a href="https://codecov.io/gh/vitali87/code-graph-rag">
<img src="https://codecov.io/gh/vitali87/code-graph-rag/graph/badge.svg" alt="Codecov" />
</a>
<a href="https://sonarcloud.io/summary/overall?id=vitali87_code-graph-rag">
<img src="https://sonarcloud.io/api/project_badges/measure?project=vitali87_code-graph-rag&metric=alert_status" alt="Quality Gate Status" />
</a>
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For better visual consistency with the other badges in the file (like the license badge), consider using shields.io to generate the Codecov and SonarCloud badges. This will ensure they all share a similar style, improving the overall presentation of the project.

Suggested change
<a href="https://codecov.io/gh/vitali87/code-graph-rag">
<img src="https://codecov.io/gh/vitali87/code-graph-rag/graph/badge.svg" alt="Codecov" />
</a>
<a href="https://sonarcloud.io/summary/overall?id=vitali87_code-graph-rag">
<img src="https://sonarcloud.io/api/project_badges/measure?project=vitali87_code-graph-rag&metric=alert_status" alt="Quality Gate Status" />
</a>
<a href="https://codecov.io/gh/vitali87/code-graph-rag">
<img src="https://img.shields.io/codecov/c/github/vitali87/code-graph-rag" alt="Codecov" />
</a>
<a href="https://sonarcloud.io/summary/overall?id=vitali87_code-graph-rag">
<img src="https://img.shields.io/sonar/quality_gate/vitali87_code-graph-rag?server=https%3A%2F%2Fsonarcloud.io" alt="Quality Gate Status" />
</a>

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 28, 2026

Greptile Summary

Added two quality metric badges to the README: Codecov coverage badge and SonarCloud Quality Gate Status badge. Both badges follow the existing formatting pattern and link to their respective project dashboards. The changes are purely cosmetic and enhance project visibility by displaying automated quality metrics.

Confidence Score: 5/5

  • This PR is safe to merge with no risk
  • Documentation-only change adding two standard badge images with correct URLs and consistent HTML formatting. No functional changes, no code modifications, and follows existing badge pattern in the README.
  • No files require special attention

Important Files Changed

Filename Overview
README.md Added Codecov coverage and SonarCloud Quality Gate Status badges to project documentation

Last reviewed commit: 7451f49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant