Skip to content

📝 docs(readme): update badge URLs#5

Merged
Onyx-Nostalgia merged 4 commits intomainfrom
refactor-badge
Aug 5, 2025
Merged

📝 docs(readme): update badge URLs#5
Onyx-Nostalgia merged 4 commits intomainfrom
refactor-badge

Conversation

@Onyx-Nostalgia
Copy link
Owner

  • update uv badge URL to use shields.io endpoint
  • update Codecov badge to reference main branch

- update uv badge URL to use shields.io endpoint
- update Codecov badge to reference main branch
@Onyx-Nostalgia Onyx-Nostalgia self-assigned this Aug 5, 2025
@codecov
Copy link

codecov bot commented Aug 5, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (28905e6) to head (60590a4).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main        #5   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           17        17           
  Branches         3         3           
=========================================
  Hits            17        17           

Copy link

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

Summary of Changes

Hello @Onyx-Nostalgia, 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 minor but important documentation maintenance within the README.md file. My aim was to ensure the project's badges are up-to-date and correctly linked, improving the accuracy and reliability of the information presented to users and contributors.

Highlights

  • README Badge Updates: I've updated the 'uv' badge URL in README.md to transition from a custom icon badge service (custom-icon-badges.demolab.com) to a standard Shields.io endpoint. This change leverages Shields.io's endpoint feature, pointing to a JSON asset for the badge data, which should provide more robust and consistent badge rendering.
  • Codecov Branch Correction: I've also corrected the Codecov badge URL in README.md to accurately reflect the project's coverage status on the main branch. Previously, it was referencing a feature-codecov branch, which is no longer relevant for the primary coverage display.
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 or fill out our survey to provide feedback.

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

@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 updates two badge URLs in the README. The change to the Codecov badge to point to the main branch is a good improvement. I've left a couple of suggestions to improve the long-term maintainability and consistency of the badge definitions.

Onyx-Nostalgia and others added 2 commits August 5, 2025 14:31
Codecov (with branch) -> codecov-badge

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@Onyx-Nostalgia
Copy link
Owner Author

/gemini review

Copy link

@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 PR updates badge URLs in the README. The changes are correct in intent, but it seems some duplicate lines were accidentally introduced. There's also a broken badge reference that needs to be fixed. I've provided comments with suggestions to clean up the file.

- update Codecov badge to use new badge variable
- remove duplicate github-actions-badge definition
@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 5, 2025

@Onyx-Nostalgia Onyx-Nostalgia marked this pull request as ready for review August 5, 2025 07:49
@Onyx-Nostalgia Onyx-Nostalgia merged commit 56b3077 into main Aug 5, 2025
22 checks passed
@Onyx-Nostalgia Onyx-Nostalgia deleted the refactor-badge branch August 5, 2025 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant