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

Enhance README: Shields to capture the attention of potential contributors #166

Closed

Conversation

devactivity-team
Copy link

I noticed you have opened issues labeled help wanted. I recommend enhancing the README to make the call for new contributors more prominent.

Changes Made:

  1. Shields: Added Shields.io badges at the top of the README

GitHub repo Good Issues for newbies GitHub Help Wanted issues GitHub Help Wanted PRs GitHub repo Issues

[![GitHub repo Good Issues for newbies](https://img.shields.io/github/issues/kubernetes-sigs/ingress2gateway/good%20first%20issue?style=flat&logo=github&logoColor=green&label=Good%20First%20issues)](https://github.com/kubernetes-sigs/ingress2gateway/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) [![GitHub Help Wanted issues](https://img.shields.io/github/issues/kubernetes-sigs/ingress2gateway/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20issues)](https://github.com/kubernetes-sigs/ingress2gateway/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub Help Wanted PRs](https://img.shields.io/github/issues-pr/kubernetes-sigs/ingress2gateway/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20PRs)](https://github.com/kubernetes-sigs/ingress2gateway/pulls?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub repo Issues](https://img.shields.io/github/issues/kubernetes-sigs/ingress2gateway?style=flat&logo=github&logoColor=red&label=Issues)](https://github.com/kubernetes-sigs/ingress2gateway/issues?q=is%3Aopen)
  1. Welcoming Message: Enhanced the README with a more prominent and inviting message to welcome new contributors.

Why This Matters:

  • Attract New Contributors: Considering there is a number of opened issues labeled 'Help Wanted' - a welcoming and appealing README is one of the most efficient ways to attract new contributors

Additional Resources:

For more insights into building a strong open-source community, check out the Building Community guide.

🚀 Thank you for considering this pull request! 🚀

Copy link

CLA Not Signed

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: devactivity-team
Once this PR has been reviewed and has the lgtm label, please assign youngnick for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@devactivity-team
Copy link
Author

I also suggest enhancing the README with the following widgets using devActivity app:

1. Dynamic Top Contributors (with avatars linked to contributor profiles)

devActivity Top Contributors Widget

2. Repo Stats

devActivity Repo Stats Widget

Feel free to explore the Live Demo and Public Dashboard for a quick overview of the app.
It makes the contribution process more exciting with gamification elements like:

  • 🌟 XP and Levels based on contributions
  • 🏆 Challenges and Achievements
  • 🏅 Leaderboard and much more!

devActivity Leaderboard

Latest repositories using devActivity: barecheck (⭐55)


Simply install an app to bring a more comprehensive and engaging community experience.

🌟 Happy Coding! 🌟

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 7, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @devactivity-team. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 7, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 5, 2024
@devactivity-team
Copy link
Author

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

That's the PR about. Anyway, closing it as old and unnecessary.
If anyone reads that, check devActivity app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants