The Onboarding Wizard guides you through a series of steps to customize devActivity for your specific project needs. This includes syncing users, configuring alerts, and setting up challenges to motivate your team.
Public Repositories (Open Source):
Step 1: User Sync and Team Management
Sync Users: devActivity automatically imports users from your GitHub organization. For personal repositories, a single user will be imported.
External Contributors: Users who are not part of your organization are automatically assigned to the "External Contributors" Team.
Create Teams: Consider creating separate Teams for active contributors to track their progress individually. You can invite them as External Managers for access to advanced reports.
More Information: Roles and Permissions, Settings.
Step 2: Alert Configuration
Default Alerts: devActivity applies a default alert configuration for public repositories.
Verification: Review and verify the alert configuration based on your project's specific needs.
Customize: Edit or disable alerts that are not relevant to your project.
Adjust Thresholds: If unsure about the alert thresholds, set higher values initially and adjust them later based on data analysis.
More Information: Alerts Configuration, Alerts Management.
Step 3: Challenge Configuration
Default Challenges: devActivity applies a default challenge configuration for public repositories.
Review: Review the challenges and their goals.
Edit Challenges: Adjust goals and XP reward values based on your project's priorities.
XP Rewards:
One-Time Challenges: Fixed XP value (e.g., 5XP).
Monthly/Accumulative Challenges: Percentage of the contributor's monthly earned XP.
Adjust Goals: If unsure about the challenge goals, set higher values initially and adjust them later.
More Information: Challenges Configuration, Active Challenges.
Step 4: Org Contributors Invitation
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
Consult the Implementation Guide: Refer to the Implementation Guide for best practices and recommendations on effectively integrating gamification into your workflow.
Private Repositories:
Step 1: User Sync and Team Management
Sync Users: devActivity automatically imports users from your GitHub organization. For personal repositories, a single user will be imported.
External Contributors: Users who are not part of your organization are automatically assigned to the "External Contributors" Team.
Create Teams: Consider creating separate Teams for active contributors to track their progress individually. You can invite them as External Managers for access to advanced reports.
More Information: Roles and Permissions, Settings.
Step 2: Alert Configuration
Default Alerts: devActivity applies a default alert configuration for private repositories.
Verification: Review and verify the alert configuration based on your project's specific needs.
Customize: Edit or disable alerts that are not relevant to your project.
Adjust Thresholds: If unsure about the alert thresholds, set higher values initially and adjust them later based on data analysis.
More Information: Alerts Configuration, Alerts Management.
Step 3: Challenge Configuration
Default Challenges: devActivity applies a default challenge configuration for private repositories.
Review: Review the challenges and their goals.
Edit Challenges: Adjust goals and XP reward values based on your project's priorities.
XP Rewards:
One-Time Challenges: Fixed XP value (e.g., 5XP).
Monthly/Accumulative Challenges: Percentage of the contributor's monthly earned XP.
Adjust Goals: If unsure about the challenge goals, set higher values initially and adjust them later.
More Information: Challenges Configuration, Active Challenges.
Step 4: Org Contributors Invitation
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
Consult the Implementation Guide: Refer to the Implementation Guide for best practices and recommendations on effectively integrating gamification into your workflow.
Common Issues and Troubleshooting:
Data Sync Issues: If you encounter data sync issues, use the "Sync Now" button in the General Settings to refresh your data.
Alert Configuration: If you have multiple teams, ensure you review and adjust the alert configuration for each team individually.
Challenge Goals: Start with higher goal values and adjust them based on data analysis.
Best Practices and Use Cases:
Open Source Projects:
Attract Contributors: Use the Public Dashboard to showcase project activity and attract new contributors.
Engage the Community: Utilize challenges and achievements to motivate and reward community members.
Private Teams:
Track Progress: Monitor team performance and identify potential bottlenecks using the various reports and dashboards.
Boost Motivation: Use gamification elements like XP, levels, and challenges to enhance team engagement and productivity.
Conclusion:
By following this onboarding guide, you can effectively configure devActivity to track your team's development activity, motivate contributors, and gain valuable insights into your project's performance. Remember to review and adjust the configuration as needed to optimize the app for your specific needs.