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 Stargazers and Forkers #341

Closed
1 task done
alo7lika opened this issue Oct 25, 2024 · 2 comments
Closed
1 task done

Add Stargazers and Forkers #341

alo7lika opened this issue Oct 25, 2024 · 2 comments
Assignees
Labels
bug Something isn't working gssoc-ext level3 45 points

Comments

@alo7lika
Copy link
Contributor

Has this bug been raised before?

  • I have checked "open" AND "closed" issues and this is not a duplicate

Description

The bug involves missing information on the project’s GitHub repository page, specifically the counts for "Stargazers" and "Forks," which are not displayed in the README. These metrics are crucial as they provide potential contributors and users with insights into the repository's popularity and community involvement. To reproduce this issue, navigate to the project’s GitHub repository and observe that there are no indicators for the number of stars or forks in the README, even though these counts are visible on GitHub's repository header. The expected behavior is for these metrics to be readily visible on the main README page, offering a quick view of the project’s engagement level. A solution to this is to add "Stargazers" and "Forks" badges in the README, which can be done through Shields.io. Adding these badges will allow visitors to quickly assess the project’s popularity and improve overall engagement with the repository.

Steps to Reproduce

Steps to Reproduce

  1. Page: Navigate to the project’s GitHub repository’s main page.
  2. Action: Look for the Stargazers and Forks metrics in the README.
  3. Expected Result: To see a display of these counts within the README for easy access.
  4. Actual Result: These metrics were absent, reducing the visibility of community engagement data on the main project page.

Screenshots

N/A

Do you want to work on this issue?

Yes

If "yes" to above, please explain how you would technically implement this

To implement the Stargazers and Forks counts in the README, I would use dynamic badges from Shields.io, which allows GitHub repositories to display real-time metrics like stars and forks directly on the page. First, I would navigate to the README file (typically README.md in the root directory) and insert the Shields.io badge links to show these metrics. This can be done by embedding Markdown syntax in the README with the following code:

GitHub stars
GitHub forks

In this code, I would replace username and repository-name with the specific GitHub username and repository name. Once added, these badges would display up-to-date counts of stars and forks, making it easier for visitors to gauge the repository's popularity and activity level directly from the README without needing to check the repository header each time.

@alo7lika alo7lika added the bug Something isn't working label Oct 25, 2024
@alo7lika
Copy link
Contributor Author

Assign me the task under GSSOC AND HACKTOBERFEST @Jaishree2310

@alo7lika
Copy link
Contributor Author

@Jaishree2310

@alo7lika alo7lika closed this as completed Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working gssoc-ext level3 45 points
Projects
None yet
Development

No branches or pull requests

2 participants