Skip to content

docs : add MIT LICENSE and README badges#303

Open
Janani-bn wants to merge 2 commits into
Kuldeeep18:mainfrom
Janani-bn:docs/271-add-license-readme-badges
Open

docs : add MIT LICENSE and README badges#303
Janani-bn wants to merge 2 commits into
Kuldeeep18:mainfrom
Janani-bn:docs/271-add-license-readme-badges

Conversation

@Janani-bn

@Janani-bn Janani-bn commented Jun 17, 2026

Copy link
Copy Markdown

Description
Added MIT LICENSE and README badges

Changes made:

  • Added MIT LICENSE file
  • Added Python version badges
  • Added Last commit badges
  • Added Django version badges
  • Added github start badge

Issue
Closes #271

Summary by CodeRabbit

  • Documentation
    • Added an MIT-style license file to the project.
    • Updated the README with Shields.io badges for Python 3.11, Django 5.0, MIT license type, latest commit status, and GitHub star count.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: e08166f1-d08c-4201-bd4f-d7152c3c8da2

📥 Commits

Reviewing files that changed from the base of the PR and between 3dc380b and 7253f11.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The LICENSE file is populated with a standard MIT license text, setting the copyright year to 2026 and attributing it to Kuldeeep18. The README.md header is updated to include five Shields.io badges displaying Python version, Django version, license type, last commit status, and GitHub star count.

Changes

License and README Metadata

Layer / File(s) Summary
MIT license and README badges
LICENSE, README.md
LICENSE is filled with full MIT license text (copyright 2026, Kuldeeep18). README.md gains five Shields.io badges at the top: Python 3.11, Django 5.0, MIT license, last commit, and GitHub stars.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A license now lives in the repo so bright,
With badges that shimmer like stars in the night.
MIT says "use freely, just give us a nod,"
While Python and Django stand proud on the sod.
Hop hop, little repo — you're legal and grand! 🌟

🚥 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 PR title clearly and concisely describes the main changes: adding a MIT LICENSE file and README badges.
Linked Issues check ✅ Passed The PR implements all requirements from #271: MIT LICENSE with 2026 copyright attribution, and README badges for Python, Django, license, last commit, and GitHub stars.
Out of Scope Changes check ✅ Passed All changes directly address the objectives in #271; no extraneous modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 2-5: The badge URLs in the README.md file contain a malformed
domain name with an extra dot. In all four badge URLs (the Python, Django,
License, and LastCommit badges), replace `img.shields.io.` with `img.shields.io`
by removing the trailing dot that appears before the forward slash in the URL
path. This will allow the badges to render correctly when the README is
displayed.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ca5c43a7-ea66-46e6-90fa-5f03d66c020c

📥 Commits

Reviewing files that changed from the base of the PR and between 90052f9 and 3dc380b.

📒 Files selected for processing (2)
  • LICENSE
  • README.md

Comment thread README.md Outdated
docs: change the img.shields.io URL in readme

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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.

docs : Add license file and Shields.io badges to README

1 participant