Add CI, documentation and license badges #494
Conversation
Summary of ChangesHello @jessp01, 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 improves the project's Highlights
Using Gemini Code AssistThe 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
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 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
|
for more information, see https://pre-commit.ci
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds CI, documentation, and license badges to the README.md file, which is a great addition for project visibility. The implementation is correct. I have one suggestion to improve the maintainability of the new badge reference links by reordering them.
|
Build failed. ❌ pre-commit FAILURE in 1m 02s |
Gemini code assist claims that this makes a difference and rates it as "moderate"; I don't think it really matters in this case, but whatever... it does no harm, either. Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Build failed. ❌ pre-commit FAILURE in 1m 03s |
| [badge-build]: https://softwarefactory-project.io/zuul/api/tenant/packit-service/badge?project=packit/specfile&pipeline=check | ||
| [build]: https://softwarefactory-project.io/zuul/t/packit-service/buildsets?project=packit%2Fspecfile&pipeline=check&skip=0 | ||
| [docs-badge]: https://img.shields.io/badge/documentation-3572A5 | ||
| [docs]: https://packit.dev/specfile/api/specfile | ||
| [badge-license]: https://img.shields.io/github/license/packit/specfile.svg | ||
| [license]: ./LICENSE |
There was a problem hiding this comment.
Hi!
Thanks for adding the links. The Github preview doesn't show these. Could you investigate further?
Thank you.
There was a problem hiding this comment.
Hi,
I can see them just fine: https://github.com/jessp01/specfile/blob/47416e29c1e75daaca1089e606707ef3b2508629/README.md
There was a problem hiding this comment.
Ok these are not supposed to be seen 😅
There was a problem hiding this comment.
Hi @majamassarini ,
Ok these are not supposed to be seen 😅
Sorry, not sure I understand what you mean by the above? These URLs are used in the top lines of the README:
[![CI][badge-build]][build]
[![Documentation][docs-badge]][docs]
[![License][badge-license]][license]It's standard practice when it comes to badges, makes it easier to read and alter.
|
recheck |
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 56s |
2 participants
No description provided.