-
Notifications
You must be signed in to change notification settings - Fork 1
Added badges #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added badges #2
Conversation
Reviewer's Guide by SourceryThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this 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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
[](https://pkg.go.dev/github.com/go-slice/slice) | ||
[](https://github.com/go-slice/slice/actions/workflows/tests.yml) | ||
[](https://coveralls.io/github/go-slice/slice?branch=main) | ||
[](https://goreportcard.com/report/github.com/go-slice/slice) |
There was a problem hiding this comment.
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.
[](https://pkg.go.dev/github.com/go-slice/slice) | |
[](https://github.com/go-slice/slice/actions/workflows/tests.yml) | |
[](https://coveralls.io/github/go-slice/slice?branch=main) | |
[](https://goreportcard.com/report/github.com/go-slice/slice) | |
[](https://pkg.go.dev/github.com/go-slice/slice#section-readme "Go Reference") | |
[](https://github.com/go-slice/slice/actions/workflows/tests.yml "Tests Status") | |
[](https://coveralls.io/github/go-slice/slice?branch=main "Code Coverage") | |
[](https://goreportcard.com/report/github.com/go-slice/slice "Go Report Card") |
Summary by Sourcery
Documentation: