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

[ENH] Add consistent badges #405

Merged
merged 3 commits into from
Dec 12, 2024
Merged

[ENH] Add consistent badges #405

merged 3 commits into from
Dec 12, 2024

Conversation

surchs
Copy link
Contributor

@surchs surchs commented Dec 11, 2024

Changes proposed in this pull request:

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR has a label for the release changelog or skip-release (to be applied by maintainers only)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

Copy link

sourcery-ai bot commented Dec 11, 2024

Reviewer's Guide by Sourcery

This PR updates the badges in the README.md file to use a consistent style (flat-square) and adds additional badges. The changes improve the visual consistency of the repository's status indicators while adding more information about the project's Docker image and build status.

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

File-Level Changes

Change Details Files
Updated and standardized repository status badges
  • Replaced existing badges with flat-square style variants
  • Added GitHub branch check runs badge
  • Added Docker pulls counter badge
  • Updated badge links to include logos for Python, Docker, and Codecov
  • Changed license badge color to purple
  • Updated documentation link path from /user_guide/cli/ to /cli/
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

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.49%. Comparing base (f68468a) to head (6754d59).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #405   +/-   ##
=======================================
  Coverage   98.49%   98.49%           
=======================================
  Files          18       18           
  Lines        1066     1066           
=======================================
  Hits         1050     1050           
  Misses         16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Overall Comments:

  • Please fill out the PR description template with the proposed changes and link to any related issues. This helps with tracking and documentation.
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 and I'll use the feedback to improve your reviews.

@rmanaem rmanaem self-requested a review December 12, 2024 17:09
Copy link
Contributor

@rmanaem rmanaem left a comment

Choose a reason for hiding this comment

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

Don't forget to add PR label 🧑‍🍳

@surchs surchs added the pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) label Dec 12, 2024
@surchs surchs merged commit c288daa into main Dec 12, 2024
11 checks passed
@surchs surchs deleted the add_badges branch December 12, 2024 20:34
@alyssadai alyssadai added skip-release PR doesn't appear in the changelog and preserves current version when merged and removed pr-internal Non-user-facing code improvement, will increment patch version when merged (0.0.+1) labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-release PR doesn't appear in the changelog and preserves current version when merged
Projects
Status: Review - Done
Development

Successfully merging this pull request may close these issues.

Standardize README badges across repos
3 participants