Skip to content

Update README with contributors and project support#260

Merged
ShantKhatri merged 1 commit into
Dev-Card:mainfrom
RehanAhmad25:docs/readme
May 23, 2026
Merged

Update README with contributors and project support#260
ShantKhatri merged 1 commit into
Dev-Card:mainfrom
RehanAhmad25:docs/readme

Conversation

@RehanAhmad25
Copy link
Copy Markdown
Contributor

@RehanAhmad25 RehanAhmad25 commented May 22, 2026

Summary

This PR adds a contributors section to the README showing contributors , along with live fork and star stats.

Closes #259


Type of Change

  • Bug fix
  • New feature
  • Refactor (no functional change)
  • UI / Design change
  • Tests only
  • Documentation
  • Infrastructure / DevOps
  • Security

What Changed

  • Added a dedicated Contributors section to recognize project contributors

  • Integrated contrib.rocks contributors graph linked to the GitHub contributors page

  • Added lightweight Project Support badges for repository stars and forks

  • Kept the section compact and visually consistent with the existing README structure

  • Improved community visibility and contributor acknowledgment without affecting existing content


How to Test

  1. Open the updated README.md in GitHub preview or local Markdown preview.
  2. Verify that the Contributors section renders correctly.
  3. Click the contributors image and confirm it redirects to the repository contributors graph.
  4. Verify that the Stars and Forks badges redirect to their respective GitHub pages.
  5. Check spacing/alignment to ensure the section matches the existing README styling.

Checklist

  • My code follows the project's coding style (pnpm -r run lint passes).
  • TypeScript compiles without errors (pnpm -r run typecheck).
  • I have added or updated tests for the changes I made.
  • All tests pass locally (pnpm -r run test).
  • I have updated documentation where necessary.
  • No new console.log or debug statements left in the code.
  • Breaking changes are documented in this PR description.

Screenshots / Recordings

Screenshot 2026-05-22 at 8 38 59 PM

@Harxhit Harxhit added the gssoc:approved Required label for every approved PR. Gives the base +50 points and enables contribution tracking. label May 22, 2026
@ShantKhatri
Copy link
Copy Markdown
Contributor

Hey @RehanAhmad25, Thanks for this PR I was expecting this in our Readme.

@ShantKhatri ShantKhatri merged commit 7a6655f into Dev-Card:main May 23, 2026
1 check failed
@RehanAhmad25
Copy link
Copy Markdown
Contributor Author

Thank you @ShantKhatri !
Glad you liked the addition and that it aligns with the README vision for the project.

Happy to contribute 🚀

@Harxhit Harxhit added level:beginner Beginner-friendly issue/PR with low complexity. (+20 pts) quality:clean PR is well-structured, readable, and follows good practices. (×1.2 multiplier) type:docs Documentation-related contribution (+5 pts) labels May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved Required label for every approved PR. Gives the base +50 points and enables contribution tracking. level:beginner Beginner-friendly issue/PR with low complexity. (+20 pts) quality:clean PR is well-structured, readable, and follows good practices. (×1.2 multiplier) type:docs Documentation-related contribution (+5 pts)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Contributors + Star + Forks in README

3 participants