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

CONTRIBUTING.md added (needs some adjustments to the project's processes) #274

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

devactivity-team
Copy link
Contributor

Acquisition of the new contributors to help with the project's challenges would be more efficient with clear contribution policy.

Changes Made:

  1. CONTRIBUTION.md Added template generated with this tool.
    It still needs some work on it to adjust for the project.

  2. Shields: Added Shields.io badges at the top of the CONTRIBUTION.md

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

🚀 Thank you for considering this pull request!

@devactivity-team
Copy link
Contributor Author

Another friendly reminder for devActivity that may help to acquire, engage and retain your contributors community. Explore Live Demo and Public Dashboard example for a quick overview.

Also, here is an example of a gamification section you can include in CONTRIBUTING.md:

🎮 Gamified Contribution Process

We've made developing open source not just rewarding but also fun by implementing gamification elements into the engineering process. Check Gamification Concept for more details.

How It Works

  • Experience Points (XP): Earn XP for each pull request, commit, code review, opened/closed issue, and comment 💪
  • Levels: Contributors are assigned specific levels based on their earned XP. 🌟

Challenges

Complete 20+ challenges to earn extra rewards. Examples include:

One-Time Challenges:

  • 🚀 First Pull Request Created
  • 🕵️‍♂️ First Code Review Done
  • 💬 First Comment Added

Monthly Challenges:

  • 🏆 Achieve a certain number of pull requests
  • 🗃 Close the oldest issue
  • ⏱ Maintain a cycle time below a specific target

Custom challenges may be created for special issues. And community heroes rewarded with achievements and extra XP. 🌈

Public Dashboard

Communitry progress via Public Dashboard, featuring:

  • 🏅 Leaderboard
  • 🎯 Active Challenges
  • 🏆 Achievements
  • 📊 General Stats

Personal Dashboard

Each contributor gets a personal dashboard to track:

  • 💼 XP/Level
  • 🏆 Earned Achievements
  • 🖼 Generate embeddable widgets for their public profile

Monthly Reports

Optionally, contributors can receive a monthly email report with their progress. 📅

Start contributing, earn XP, and overcome challenges together.
Let's make open source development an exciting journey!

Happy coding! 🚀

@vitaliimelnychuk vitaliimelnychuk merged commit b5e4d33 into barecheck:v1 Jul 8, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants