Skip to content

docs: use a static MIT license badge#355

Merged
pratyush618 merged 1 commit into
masterfrom
fix/readme-static-license-badge
Jul 2, 2026
Merged

docs: use a static MIT license badge#355
pratyush618 merged 1 commit into
masterfrom
fix/readme-static-license-badge

Conversation

@pratyush618

@pratyush618 pratyush618 commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

What

The root README license badge used img.shields.io/github/license/..., which resolves the label by calling GitHub's license-detection API through shields.io. When that call is rate-limited (or the license is momentarily undetected), shields renders license invalid — and GitHub's camo image proxy caches that stale render, so the README shows "invalid" even though GitHub detects the repo as MIT (spdx_id: MIT) and the live badge resolves to MIT.

Swaps it for a static badge/license-MIT-blue badge. The license is fixed (MIT), so there's no need to query GitHub's API — the badge can no longer flake to "invalid". The link still points at LICENSE.

Docs-only, root README.

Summary by CodeRabbit

  • Documentation
    • Updated the license badge in the project README to point to the MIT license file.

@github-actions github-actions Bot added the docs label Jul 2, 2026
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 58 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eeeb0832-d88a-4cb7-93b4-2a9ec6faf730

📥 Commits

Reviewing files that changed from the base of the PR and between e864e8b and 6302528.

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

Walkthrough

The license badge URL in README.md's centered header section was updated from a GitHub license endpoint to a shields.io MIT badge linking to the repository's LICENSE file.

Changes

README License Badge

Layer / File(s) Summary
Update license badge link
README.md
Replaced the GitHub license badge URL with a shields.io MIT badge linked to the LICENSE file.

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

🚥 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 matches the docs-only change to switch the README license badge to a static MIT badge.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 fix/readme-static-license-badge

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

@pratyush618
pratyush618 force-pushed the fix/readme-static-license-badge branch from e864e8b to 6302528 Compare July 2, 2026 05:38
@pratyush618
pratyush618 merged commit 2061deb into master Jul 2, 2026
11 checks passed
@pratyush618
pratyush618 deleted the fix/readme-static-license-badge branch July 2, 2026 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant