Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝[Docs]: Add Table to Display Repository Statistics in README.md #146

Open
4 tasks done
BhavaniSankar0107 opened this issue Oct 23, 2024 · 2 comments
Open
4 tasks done
Labels
enhancement New feature or request

Comments

@BhavaniSankar0107
Copy link

BhavaniSankar0107 commented Oct 23, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Issue Description

The issue involves adding a table to display repository statistics, such as the number of stars, forks, issues, and pull requests, directly in the README.md file. This will help contributors and users track the activity and contributions at a glance.

Suggested Change

Steps to Implement:

  1. Create a table in the README.md file displaying the following repository statistics:
    • Stars
    • Forks
    • Open Issues
    • Open Pull Requests
    • Closed Pull Requests
  2. Use markdown syntax to include badges or icons for each statistic.
  3. Add dynamic links to the corresponding sections of the repository for easy access (e.g., link to the "Issues" or "Pull Requests" tabs).

Expected Behavior:

The README.md file will contain a neatly formatted table that displays real-time repository statistics, making the repository's activity more visible and engaging for contributors and users.

Screenshot (for reference):

Screenshot 2024-10-23 094403

Rationale

This documentation update enhances visibility of project activity, attracting potential contributors by showcasing real-time statistics in the README.md. It improves user experience and encourages collaboration, fostering a more engaging and professional environment for the repository.

Urgency

Medium

Record

  • I have read the Contributing Guidelines
  • I'm a GSSOC'24 contributor
  • I want to work on this issue
@BhavaniSankar0107 BhavaniSankar0107 added the enhancement New feature or request label Oct 23, 2024
Copy link

Congratulations, @BhavaniSankar0107! 🎉 Thank you for creating your issue. Your contribution is greatly appreciated and we look forward to working with you to resolve the issue. Keep up the great work!

We will promptly review your changes and offer feedback. Keep up the excellent work! Kindly remember to check our contributing guidelines

@divyalakshmi0
Copy link

Can you please assign , I would love to work on it!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants