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

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

P.S. I also noticed that star history widget is broken (at least for me)
image

@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)

You won't need to update current contributors widget manually

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! 🌟

@adamlui
Copy link
Member

adamlui commented Jul 8, 2024

Hey the star history being broken sometimes happens for me too, can you confirm upon refresh it fixes it?

Re: the new shield cluster, I think having so many shields related to the same topic of Issues may be too much, also I rarely open "Help Wanted" issues and that was the only one I opened

Re: your Contributors widget, it doesn't cover those who opened issues or did testing on other platforms (like Greasy Fork) is why the manual method is more comprehensive and useful (but I did consider your software before)

@olegcherev
Copy link

Hey the star history being broken sometimes happens for me too, can you confirm upon refresh it fixes it?

Re: the new shield cluster, I think having so many shields related to the same topic of Issues may be too much, also I rarely open "Help Wanted" issues and that was the only one I opened

Re: your Contributors widget, it doesn't cover those who opened issues or did testing on other platforms (like Greasy Fork) is why the manual method is more comprehensive and useful (but I did consider your software before)

Hey,

Star trend looks better now for me

image

Got your point about fork contributors, will add it as an idea for later. Thanks!

@adamlui
Copy link
Member

adamlui commented Jul 8, 2024

If you add option to enable auto-add of authors of Issues closed as Completed or tagged w/ label indicative of an app contribution like 'Enhancement' or 'Bug', or allow me to enter custom contributors, then I would use your software right away

@adamlui adamlui added the documentation Improvements or additions to documentation label Jul 8, 2024
@olegcherev
Copy link

If you add option to enable auto-add of authors of Issues closed as Completed or tagged w/ label indicative of an app contribution like 'Enhancement' or 'Bug', or allow me to enter custom contributors, then I would use your software right away

Thanks! Sounds like something I will discuss with the team

@olegcherev
Copy link

@adamlui just one more quick question - what do you think of gamification of the dev process based on contributions? leaderboard/levels/XP/challenges etc...

@adamlui
Copy link
Member

adamlui commented Jul 8, 2024

@olegcherev that sounds interesting,, but me personally (and probably for countless many others) when I contribute to some project, it is for the recognition for having contributed to a notable project for clout. And visibility depends on number of contributions is what drives that activity (since avatars are sorted by that). So gamification would not incentivize me, rather if it gives me more visibility if maintainer using your DevActivity somehow utilizes that as a reward instead

@adamlui
Copy link
Member

adamlui commented Jul 8, 2024

... unless the reward points can be exchanged for something of monetary value. But Open Source maintainers will not have such resources to fund the contributions. So author visibility becomes the highest motivator.

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

Successfully merging this pull request may close these issues.

3 participants