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

[Documentation] Add Table to Display Repository Statistics in README.md #167

Open
6 tasks done
BhavaniSankar0107 opened this issue Oct 23, 2024 · 3 comments
Open
6 tasks done
Assignees
Labels
chaos Chaotic update documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points

Comments

@BhavaniSankar0107
Copy link
Contributor

Describe the Documentation Update

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.

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.

Add References or Examples

Screenshot (for reference):

Screenshot 2024-10-23 094403

Confirm

  • I understand that my update will add to the chaos and I'm okay with it
  • I agree to follow this project's Code of Conduct
  • I want to work on this documentation update
  • I'm GSSOC'24 Extd registered Contributor
  • I'm Hacktoberfest registered Contributor
@BhavaniSankar0107 BhavaniSankar0107 added chaos Chaotic update documentation Improvements or additions to documentation labels Oct 23, 2024
Copy link
Contributor

👋 Hey @BhavaniSankar0107! Thanks for stepping into the chaos and opening an issue in the ChaosWeb project. We embrace disorder, and your contribution adds to the delightful mess! 🎉
Welcome to the wild side of web design. Expect the unexpected! 🌍🌀

Copy link
Contributor

👋 Hey @BhavaniSankar0107! Thanks for opening an issue in the ChaosWeb project. We’re excited to see how you’ve contributed to the delightful mess. Our team will review it soon. Stay chaotic! 🎯

@vansh-codes
Copy link
Owner

Go ahead!

@vansh-codes vansh-codes added gssoc-ext GSSOC'24 Extd Participant level1 awards 10 points hacktoberfest-accepted hacktoberfest accepted labels Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chaos Chaotic update documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level1 awards 10 points
Projects
None yet
Development

No branches or pull requests

2 participants