Skip to content

Conversation

bkrukowski
Copy link
Contributor

@bkrukowski bkrukowski commented Oct 21, 2024

Summary by Sourcery

Documentation:

  • Add badges for Go Reference, Tests, Coverage Status, and Go Report Card to the README.

Copy link

sourcery-ai bot commented Oct 21, 2024

Reviewer's Guide by Sourcery

This pull request adds several badges to the README.md file, enhancing the project's visibility and providing quick access to important information for users and contributors.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added multiple badges to the README.md file
  • Added Go Reference badge linking to the package documentation
  • Added Tests badge showing the status of GitHub Actions workflow
  • Added Coverage Status badge from Coveralls
  • Added Go Report Card badge
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bkrukowski bkrukowski merged commit ce6b22b into main Oct 21, 2024
7 checks passed
@bkrukowski bkrukowski deleted the badges branch October 21, 2024 20:01
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @bkrukowski - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief description of the project above or below the badges to provide context for visitors and explain what the 'slice' project does.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +1 to +4
[![Go Reference](https://pkg.go.dev/badge/github.com/go-slice/slice.svg)](https://pkg.go.dev/github.com/go-slice/slice)
[![Tests](https://github.com/go-slice/slice/actions/workflows/tests.yml/badge.svg)](https://github.com/go-slice/slice/actions/workflows/tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/go-slice/slice/badge.svg?branch=main)](https://coveralls.io/github/go-slice/slice?branch=main)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-slice/slice)](https://goreportcard.com/report/github.com/go-slice/slice)
Copy link

Choose a reason for hiding this comment

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

suggestion (documentation): Consider adding alt text to badge images for improved accessibility.

While the badges are correctly formatted and linked, adding alt text to the images would make the README more accessible to users relying on screen readers.

Suggested change
[![Go Reference](https://pkg.go.dev/badge/github.com/go-slice/slice.svg)](https://pkg.go.dev/github.com/go-slice/slice)
[![Tests](https://github.com/go-slice/slice/actions/workflows/tests.yml/badge.svg)](https://github.com/go-slice/slice/actions/workflows/tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/go-slice/slice/badge.svg?branch=main)](https://coveralls.io/github/go-slice/slice?branch=main)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-slice/slice)](https://goreportcard.com/report/github.com/go-slice/slice)
[![Go Reference](https://pkg.go.dev/badge/github.com/go-slice/slice.svg)](https://pkg.go.dev/github.com/go-slice/slice#section-readme "Go Reference")
[![Tests](https://github.com/go-slice/slice/actions/workflows/tests.yml/badge.svg)](https://github.com/go-slice/slice/actions/workflows/tests.yml "Tests Status")
[![Coverage Status](https://coveralls.io/repos/github/go-slice/slice/badge.svg?branch=main)](https://coveralls.io/github/go-slice/slice?branch=main "Code Coverage")
[![Go Report Card](https://goreportcard.com/badge/github.com/go-slice/slice)](https://goreportcard.com/report/github.com/go-slice/slice "Go Report Card")

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