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

add badges to README #19

Merged
merged 1 commit into from
Jan 27, 2024
Merged

add badges to README #19

merged 1 commit into from
Jan 27, 2024

Conversation

NKeleher
Copy link
Owner

badges!

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.

PR Type: Documentation

PR Summary: The pull request adds a set of badges to the README file of the statsframe project, enhancing the documentation by providing quick visual information about the package, such as the current version on PyPI, supported Python versions, license, and repository status.

Decision: Comment

📝 Type: 'Documentation' - not supported yet.
  • Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
✅ Small diff: the diff is small enough to approve with confidence.
No details provided.

General suggestions:

  • Ensure that the links associated with badges are functional and lead to the intended targets. For example, the license badge should link to the actual license file in the repository to facilitate easy access for users.
  • Consider providing a more descriptive pull request body that explains the purpose and benefit of the added badges, which can be helpful for historical reference and for reviewers who may not be familiar with the use of badges in documentation.

Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨

Share Sourcery

Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Show resolved Hide resolved
@NKeleher NKeleher merged commit 0daf4cf into main Jan 27, 2024
9 checks passed
@NKeleher NKeleher deleted the add-badges branch January 27, 2024 00:20
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