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 #2378

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

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/kubeflow/katib/good%20first%20issue?style=flat&logo=github&logoColor=green&label=Good%20First%20issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) [![GitHub Help Wanted issues](https://img.shields.io/github/issues/kubeflow/katib/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub Help Wanted PRs](https://img.shields.io/github/issues-pr/kubeflow/katib/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20PRs)](https://github.com/kubeflow/katib/pulls?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub repo Issues](https://img.shields.io/github/issues/kubeflow/katib?style=flat&logo=github&logoColor=red&label=Issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen)

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

🚀 Thank you for considering this pull request! 🚀

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign andreyvelich 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! 🌟

Copy link

github-actions bot commented Oct 7, 2024

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@@ -261,6 +261,8 @@ about getting involved in the community:

## Contributing

[![GitHub repo Good Issues for newbies](https://img.shields.io/github/issues/kubeflow/katib/good%20first%20issue?style=flat&logo=github&logoColor=green&label=Good%20First%20issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) [![GitHub Help Wanted issues](https://img.shields.io/github/issues/kubeflow/katib/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub Help Wanted PRs](https://img.shields.io/github/issues-pr/kubeflow/katib/help%20wanted?style=flat&logo=github&logoColor=b545d1&label=%22Help%20Wanted%22%20PRs)](https://github.com/kubeflow/katib/pulls?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) [![GitHub repo Issues](https://img.shields.io/github/issues/kubeflow/katib?style=flat&logo=github&logoColor=red&label=Issues)](https://github.com/kubeflow/katib/issues?q=is%3Aopen)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the late review @devactivity-team!
I think, it is a great enhancement for the contributing section.
What do you think @kubeflow/wg-training-leads ?

@andreyvelich
Copy link
Member

Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Helped wanted PRs" and "GitHub repo Issues" do not seem very useful.

@andreyvelich
Copy link
Member

"Helped wanted PRs" and "GitHub repo Issues" do not seem very useful.

Yeah, maybe we can remove 2 of these.

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

Successfully merging this pull request may close these issues.

3 participants