Skip to content

[docs] B: Fix Readme Badges#65

Merged
csegarragonz merged 2 commits intomainfrom
bugfix-docs
Dec 6, 2025
Merged

[docs] B: Fix Readme Badges#65
csegarragonz merged 2 commits intomainfrom
bugfix-docs

Conversation

@csegarragonz
Copy link
Contributor

No description provided.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @csegarragonz, 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 enhancing the README.md file by improving the accuracy and presentation of its badges. It updates the version badge to automatically reflect the latest release tag via shields.io and applies modern CSS flexbox styling to ensure all badges are well-aligned and spaced.

Highlights

  • Version Badge Update: The version badge in README.md has been updated to dynamically display the latest release tag using shields.io, replacing the previous static version.svg.
  • Badge Layout Improvement: The styling for the badges in README.md has been refactored to use CSS flex properties (display: flex, gap, justify-content, align-items) for better visual alignment and spacing.
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 updates the badges in the README.md file, notably switching to a dynamic version badge from shields.io. While this is a good improvement, I've provided a suggestion to restore the clickability of the version badge by linking it to the project's releases page, and to improve the overall HTML formatting for better readability and maintainability.

Comment on lines +8 to 15
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml"><img src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg" alt="Integration Tests" /></a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml"><img src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg" alt="SNP End-to-End Tests" /></a>
</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The new dynamic version badge is a great change! However, the updated HTML block has a couple of issues: the version badge is no longer clickable, and the formatting for the other badges has become less readable. I'd suggest wrapping the version badge in a link to the releases page and restoring the multi-line formatting for all badges to improve readability and maintainability.

Suggested change
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml"><img src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg" alt="Integration Tests" /></a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml"><img src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg" alt="SNP End-to-End Tests" /></a>
</p>
<p style="display: flex; gap: 6px; justify-content: center; align-items: center;">
<a href="https://github.com/faasm/tless/releases">
<img
src="https://img.shields.io/github/v/tag/faasm/tless?sort=semver&label=version"
alt="Accless Version"
/>
</a>
<a href="https://github.com/faasm/tless/actions/workflows/tests.yml">
<img
src="https://github.com/faasm/tless/actions/workflows/tests.yml/badge.svg"
alt="Integration Tests"
/>
</a>
<a href="https://github.com/faasm/tless/actions/workflows/snp.yml">
<img
src="https://github.com/faasm/tless/actions/workflows/snp.yml/badge.svg"
alt="SNP End-to-End Tests"
/>
</a>
</p>

@csegarragonz csegarragonz marked this pull request as ready for review December 6, 2025 11:40
@csegarragonz csegarragonz merged commit b9ea6c6 into main Dec 6, 2025
7 of 8 checks passed
@csegarragonz csegarragonz deleted the bugfix-docs branch December 6, 2025 11:41
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