Skip to content

docs: add CI status badge to README#2

Merged
Boulea7 merged 1 commit intomainfrom
yolo/earn-badge
Mar 13, 2026
Merged

docs: add CI status badge to README#2
Boulea7 merged 1 commit intomainfrom
yolo/earn-badge

Conversation

@Boulea7
Copy link
Owner

@Boulea7 Boulea7 commented Mar 13, 2026

Summary by Sourcery

Documentation:

  • Display the GitHub Actions CI status badge in both the main and English README files.

@sourcery-ai
Copy link

sourcery-ai bot commented Mar 13, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a GitHub Actions CI status badge to both the main and English README files, linking to the existing ci.yml workflow.

File-Level Changes

Change Details Files
Expose CI workflow status via badges in documentation headers.
  • Insert a CI status shield.io-style badge in the badge row near the top of the primary README.
  • Insert the same CI status badge in the badge row of the English README, keeping consistent ordering with existing badges.
  • Link both badges to the GitHub Actions ci.yml workflow page for quick access to run details.
README.md
README_EN.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

@Boulea7 Boulea7 merged commit 13aacb4 into main Mar 13, 2026
2 checks passed
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 - I've reviewed your changes and they look great!


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.

@Boulea7 Boulea7 deleted the yolo/earn-badge branch March 13, 2026 14:16
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