Skip to content

docs: badge the README with CI, PyPI and license - #9

Merged
ctrondlp merged 1 commit into
mainfrom
P3-readme-badges
Sep 14, 2026
Merged

ctrondlp merged 1 commit into
mainfrom
P3-readme-badges

Conversation

@ctrondlp

@ctrondlp ctrondlp commented Sep 14, 2026 •

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Added status badges to the README for continuous integration, package publication, and licensing.
    • Badges link to the relevant workflow, package page, and license information.

@coderabbitai

coderabbitai Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 624ad49b-e1ac-4525-8197-35e47480bf8c

📥 Commits

Reviewing files that changed from the base of the PR and between 9667c53 and 11604a8.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Project status badges

Layer / File(s) Summary
Add project status badges
README.md
The README now includes CI, PyPI, and license badges with links to their corresponding resources.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 11604

This documentation-only change adds project badges with verified targets and is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README changes. It identifies the three added badge types: CI, PyPI, and license.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch P3-readme-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ctrondlp
ctrondlp merged commit a101ecd into main Sep 14, 2026
8 checks passed
@ctrondlp
ctrondlp deleted the P3-readme-badges branch September 14, 2026 21:42
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