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

Add GitHub Repository Stats to README.md #36

Open
3 tasks done
Ganeshmoorthii opened this issue Oct 28, 2024 · 1 comment
Open
3 tasks done

Add GitHub Repository Stats to README.md #36

Ganeshmoorthii opened this issue Oct 28, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Ganeshmoorthii
Copy link

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 in the repository at a glance.

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, along with dynamic links to the corresponding sections of the repository.

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.

Additional Information:

  • This enhancement will make the repository more user-friendly by providing visibility into its overall activity.
  • The table can be dynamically updated by using GitHub shields or other badge services to fetch real-time stats.

Screenshot (for reference):

Screenshot 2024-10-20 145520


Checklist:

  • I have checked the existing issues.
  • I have read the Contributing Guidelines.
  • I want to work on this issue.
@Ganeshmoorthii Ganeshmoorthii added the documentation Improvements or additions to documentation label Oct 28, 2024
Copy link

Hello! Thank you so much for filing an issue that helps us to improve.

If this is a bug report, please include relevant logs to help us debug the problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant