Skip to content

[Documentation Update]: Add Table to Display Repository Statistics in README.md #195

@BhavaniSankar0107

Description

@BhavaniSankar0107

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 have starred the repository

Metadata

Metadata

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions