This guide will walk you through the implementation of devActivity's gamification features for both public (open-source) and private repositories. We'll cover how to leverage these features to engage your community, motivate your team, and achieve your project goals.
Public Repositories (Open Source)
What to expect after devActivity app installation?
Account Creation: A new workspace will be created automatically after you install the devActivity app.
Contribution Tracking: devActivity will start processing repository metadata and tracking contributions.
XP and Levels: Contributors will earn XP for their contributions, which will determine their level.
Challenges: Over 20 challenges are available, categorized as one-time, monthly, and accumulative.
Public Dashboard: A public dashboard displays a leaderboard, contributor stats, and other widgets.
Pull Request Comments: devActivity's bot comments on pull requests with:
Summary comment after merge
Completed challenges comment
Sign-up link for External Contributors (individuals contributing to the project)
Org Contributor Dashboard: Provides detailed reports on contributions, work quality, contributors, and discussions.
Alerts: Alerts notify users about active challenges, leaderboard updates, and other relevant information.
Who is an Org Contributor? An Org Contributor is a member of the GitHub organization that manages the repository. They have access to the Organization Dashboard and can view detailed reports on the project's activity. Please note, that you need to invite Org Contributors to sign up using your common communication channel. Here is an example message:
Hey everyone! I've installed the devActivity app for our GitHub organization. Please sign up to take advantage of gamification, contribution analytics, performance reviews, retrospective insights, and much more. Check it out here: https://app.devactivity.com
Who is an External Contributor? An External Contributor is someone who contributes to the project but is not part of the organization managing the repository. They can sign up for a devActivity account to track their own progress and achievements.
After signing up, Org Contributors get:
Organization Dashboard: Provides detailed reports on:
Contributions: Track the quantity and types of contributions made by developers.
Work Quality: Analyze code quality, bug rates, and other quality-related indicators.
Contributors: Get a detailed breakdown of individual contributor activity and performance metrics.
Discussions: Analyze developer interactions and collaboration within the platform.
Alerts: Receive notifications about active challenges, leaderboard updates, and other relevant information.
Active Challenges: Track progress on ongoing challenges.
Leaderboard: View the leaderboard and see how contributors rank.
After signing up, External Contributors get:
Personal Dashboard: Track their own progress and achievements.
Monthly Report: Receive a summary of their contributions and progress.
Personal Embeddables: Embed their progress and achievements on personal websites or profiles.
What to do to make even more impact?
Community Communication
Community Announcement:
Discussions:
Subject: Exciting News: Gamification Implementation! 🚀
Dear Contributors,
🎮 We've just implemented gamification elements in our project using devActivity app. Earn XP, unlock Levels, and conquer Challenges as you contribute. Closed Pull Requests will now have summary comments with your achievements.
🏆 Check out our new Public Dashboard to showcase your achievements!
You’re welcome to sign up for devActivity account to track your progress using Personal Dashboard.
Your feedback is crucial as we embark on this gamified journey together. Happy coding and gaming!
Group Chat messages (Slack, Discord, etc):
Contributors,
🎮 We've just implemented gamification elements in our project using devActivity app. Earn XP, unlock Levels, and conquer Challenges as you contribute. Closed Pull Requests will now have summary comments with your achievements.
🏆 Check out our new Public Dashboard to showcase your achievements!
You’re welcome to sign up for devActivity account to track your progress using Personal Dashboard.
Your feedback is crucial as we embark on this gamified journey together. Happy coding and gaming!
Communicate valuable inactive contributors:
Direct contact (email, chat):
[Contributor's Name],
Your contributions have been missed for ProjectName! We've added gamification, and you're already at Level 8 with 365 XP.
Ready to jump back in?
Tag under their PR, issues:
Your contributions have been missed for ProjectName! We've added gamification, and you're already at Level 8 with 365 XP.
Ready to jump back in?
Useful Resources:
Contribution Score and XP: Explain how contributions are scored and XP is awarded.
XP to Levels Table: Provide a table outlining the XP required for each level.
Challenges Reward Types: Describe the rewards for completing different challenges.
Engage Feedback and Open Discussion: Encourage contributors to share their feedback and ideas for improving the gamification system.
README.md improvements
Contributing section update (or create):
Attention! Our Project is Leveled Up! Earn XP, Achieve Levels, Conquer Challenges, and Shine on the Leaderboard. [Learn more]
Add a short message about Gamification and link to CONTRIBUTING.md:
Join the Gamification Revolution! Earn XP, unlock Levels, and conquer Challenges. Learn more about our gamified contribution system in the CONTRIBUTING.md file.
Add a kind of shield at the top to attract attention:
![Gamified Contribution Odyssey Shield]
![Achieve, Game On Shield]
![Quest for Impact Shield]
![Contribute, Level Up Shield]
CONTRIBUTING.md improvements
Add shield:
![Gamified Contribution Odyssey Shield]
![Achieve, Game On Shield]
![Quest for Impact Shield]
![Contribute, Level Up Shield]
Add Gamification section:
## Gamification
We've implemented a gamification system to make contributing to this project more engaging and rewarding. Here's how it works:
[Explain the XP system, levels, and challenges.]
Sample message:
Join us on this gamified journey! Earn XP, unlock levels, and conquer challenges while contributing to this project. Let's level up together!
How to keep the community engaged with gamification?
Track the trend of the contribution with the Contributors report.
Configure Alert targets suitable for your project and process. Recommended to consider:
No activity from Contributor for X working days
No reviewer assigned to PR for X hours
More than X hours for PR's Pickup Time
More than X comments for a single PR
More than X comments for a single issue
Track the challenge's progress, and keep goals actual.
Assign custom achievements for community heroes.
Use custom challenges for some issues with higher complexity or scope. One per week or a few per month is recommended.
Ask to share the ideas for new challenges/achievements.
Private Repositories
What to expect after devActivity app installation?
Account Creation: A new workspace will be created automatically after you install the devActivity app.
Contribution Tracking: devActivity will start processing repository metadata and tracking contributions.
XP and Levels: Contributors will earn XP for their contributions, which will determine their level.
Challenges: Over 20 challenges are available, categorized as one-time, monthly, and accumulative.
Dashboard: A dashboard displays a leaderboard, contributor stats, and other widgets.
Pull Request Comments: devActivity's bot comments on pull requests with:
Summary comment after merge
Completed challenges comment
Who is an Org Contributor? An Org Contributor is a member of the GitHub organization that manages the repository. They have access to the Organization Dashboard and can view detailed reports on the project's activity. Please note, that you need to invite Org Contributors to sign up using your common communication channel. Here is an example message:
Hey everyone! I've installed the devActivity app for our GitHub organization. Please sign up to take advantage of gamification, contribution analytics, performance reviews, retrospective insights, and much more. Check it out here: https://app.devactivity.com
What to do to make even more impact?
Community Communication / Team Announcement:
Email:
Subject: Gamification is Here! Level Up Your Contributions!
Hi Team,
We're excited to announce the launch of our new gamification system powered by devActivity! Earn XP, unlock levels, and conquer challenges as you contribute to our projects.
[Explain the basic features of the gamification system.]
Stay tuned for more updates and exciting challenges! Happy coding!
Group Chat messages (Slack, Discord, etc):
Team, get ready to level up! We've just implemented gamification using devActivity. Earn XP, unlock levels, and conquer challenges! Check out the dashboard for more details.
Useful Resources:
Contribution Score and XP: Explain how contributions are scored and XP is awarded.
XP to Levels Table: Provide a table outlining the XP required for each level.
Challenges Reward Types: Describe the rewards for completing different challenges.
Engage Feedback and Open Discussion: Encourage team members to share their feedback and ideas for improving the gamification system.
What are additional motivations based on Contribution progress?
Meaningful Rewards
Offer rewards that are appealing and relevant to your audience. Provide both intrinsic rewards (recognition, status) and extrinsic rewards (discounts, merchandise). Here are some general ideas:
Professional Development Opportunities: Reward developers with access to conferences, workshops, or online courses to enhance their skills and stay updated on industry trends.
Flexible Work Arrangements: Offer the flexibility to work remotely, choose preferred work hours, or participate in a "hackathon" week where developers can work on innovative projects.
Recognition and Visibility: Showcase top-performing developers on the company website, in newsletters, or during team meetings, providing public recognition for their achievements.
Gadget or Tech Gear Allowance: Provide a budget for developers to purchase gadgets, tech gear, or software tools that contribute to their productivity and enjoyment.
Extra Vacation Days: Grant additional vacation days as a reward for reaching specific XP milestones or completing challenging projects.
Personalized Workspace Upgrades: Allow developers to upgrade their workstations with customized equipment, ergonomic furniture, or personalized decorations based on their preferences.
Team Outings or Retreats: Organize team-building activities, outings, or retreats as a reward for achieving collective goals or milestones.
Wellness Programs: Introduce wellness programs such as gym memberships, meditation sessions, or health-related workshops to support the physical and mental well-being of developers.
Special Project Opportunities: Provide the opportunity to work on special projects, research initiatives, or innovation labs as a reward for reaching higher levels or demonstrating exceptional skills.
Profit-Sharing or Bonuses: Implement a profit-sharing system or provide bonuses based on individual or team achievements, encouraging a sense of shared success.
Merchandise Ideas:
Customized Developer Swag: Design and offer exclusive swag items such as T-shirts, hoodies, or caps featuring a unique design that represents the development team or achievement levels.
Stylish Laptop Stickers: Create a set of high-quality laptop stickers that developers can proudly display to showcase their achievements, levels, or special accomplishments.
Tech Accessories Bundle: Bundle together useful tech accessories like mouse pads, phone stands, and cable organizers with custom branding related to the gamification elements.
Customized Water Bottles or Mugs: Provide durable water bottles or coffee mugs featuring custom designs, achievement badges, or level indicators to make a functional yet personalized reward.
Premium Quality Notebooks: Offer high-quality notebooks or journals with custom covers and pages, creating a branded space for developers to jot down ideas, notes, or project plans.
Branded USB Drives: Design USB drives with the company or gamification branding, possibly pre-loaded with development resources, tools, or exclusive content as a bonus.
Game-themed Desk Toys: Introduce unique desk toys or figurines related to gaming or coding, adding a playful touch to developers' workspaces.
Quality Backpacks or Tech Bags: Provide durable backpacks or tech bags with custom embroidery or patches indicating different levels or achievements in the gamification system.
Exclusive Developer Pins: Create a collection of collectible enamel pins that developers can proudly display on their clothing or accessories, each representing a specific achievement or milestone.
Limited Edition Art Prints: Commission or create limited edition art prints featuring custom artwork related to the gamification elements, allowing developers to decorate their workspaces with unique pieces.
Make a real-world impact: Connect gamification achievements to real-world benefits or social causes. Tie accomplishments to tangible outcomes, such as charity donations or community projects.
How to keep the team engaged with gamification?
Personal Development Opportunities: Integrate gamified elements that contribute to the team's professional development. Offer opportunities for skill-building and growth through the gamified system.
Social Features and Events: Facilitate social interaction through features like forums, chat, or team events. Organize occasional team-building activities or social events to strengthen connections.
Message Examples
Community Announcements
Discussions:
Subject: Exciting News: Gamification Implementation! 🚀
Dear Contributors,
🎮 We've just implemented gamification elements in our project using devActivity app. Earn XP, unlock Levels, and conquer Challenges as you contribute. Closed Pull Requests will now have summary comments with your achievements.
🏆 Check out our new Public Dashboard to showcase your achievements!
You’re welcome to sign up for devActivity account to track your progress using Personal Dashboard.
Your feedback is crucial as we embark on this gamified journey together. Happy coding and gaming!
Groups (Discord/Slack):
Contributors,
🎮 We've just implemented gamification elements in our project using devActivity app. Earn XP, unlock Levels, and conquer Challenges as you contribute. Closed Pull Requests will now have summary comments with your achievements.
🏆 Check out our new Public Dashboard to showcase your achievements!
You’re welcome to sign up for devActivity account to track your progress using Personal Dashboard.
Your feedback is crucial as we embark on this gamified journey together. Happy coding and gaming!
Inactive Contributors Communication
Direct Contact:
[Contributor's Name],
Your contributions have been missed for ProjectName! We've added gamification, and you're already at Level 8 with 365 XP.
Ready to jump back in?
Contribution Comment:
Your contributions have been missed for ProjectName! We've added gamification, and you're already at Level 8 with 365 XP.
Ready to jump back in?
README.md improvements
Contributing section update (or create):
Attention! Our Project is Leveled Up! Earn XP, Achieve Levels, Conquer Challenges, and Shine on the Leaderboard. [Learn more]
Add a kind of shield at the top to attract attention:
![Gamified Contribution Odyssey Shield]
![Achieve, Game On Shield]
![Quest for Impact Shield]
![Contribute, Level Up Shield]
CONTRIBUTING.md improvements
Add shield:
![Gamified Contribution Odyssey Shield]
![Achieve, Game On Shield]
![Quest for Impact Shield]
![Contribute, Level Up Shield]
Add Gamification section:
## Gamification
We've implemented a gamification system to make contributing to this project more engaging and rewarding. Here's how it works:
[Explain the XP system, levels, and challenges.]
Sample message:
Join us on this gamified journey! Earn XP, unlock levels, and conquer challenges while contributing to this project. Let's level up together!
Additional Info
How are contributions rewarded with XP?
How are Levels assigned based on earned XP?
How are Challenges rewarded with XP?
By following these guidelines and adapting them to your specific project needs, you can successfully implement devActivity's gamification features to enhance engagement, motivate your community, and achieve your project goals.
Recommendations
Share your gamification case with our community