Skip to content
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

more badges! #130

Merged
merged 2 commits into from
Aug 19, 2024
Merged

more badges! #130

merged 2 commits into from
Aug 19, 2024

Conversation

ryansurf
Copy link
Owner

@ryansurf ryansurf commented Aug 19, 2024

General:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Code:

  1. Does your submission pass tests?
  2. Have you run the linter/formatter on your code locally before submission?
  3. Have you updated the documentation/README to reflect your changes, as applicable?
  4. Have you added an explanation of what your changes do?
  5. Have you written new tests for your changes, as applicable?

Summary by Sourcery

Enhance the README.md by adding badges for GitHub last commit and license to provide more information at a glance.

Documentation:

  • Add badges for GitHub last commit and license to the README.md file.

Copy link
Contributor

sourcery-ai bot commented Aug 19, 2024

Reviewer's Guide by Sourcery

This pull request adds two new badges to the README.md file: one for the last commit date and another for the project's license. These additions enhance the project's visibility and provide quick access to important information for potential contributors and users.

File-Level Changes

Files Changes
README.md Added a GitHub last commit badge to display the date of the most recent commit
README.md Added a license badge to show the project is under the MIT license

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@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 @ryansurf - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Thank you for adding more information to the README. Consider reviewing the necessity of each badge and ensure that the information they provide (especially the license) is also documented in the appropriate sections of the README or other project documentation. This will help maintain a balance between informative presentation and readability.
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: all looks good

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 to tell me if it was helpful.

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@ryansurf ryansurf merged commit 356787f into main Aug 19, 2024
8 checks passed
@ryansurf ryansurf deleted the more-badges branch August 20, 2024 19: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