Permissions
Org Admin | Team Manager (for assigned team) | Org Contributor | External Contributor |
View Edit | No access | No access | No access |
The Settings section provides a centralized hub for managing various aspects of your devActivity experience, including:
General Settings: Configure your organization's timezone, work schedule, and enable features like Pull Request Comments and Peer Feedback.
Team/Users Management: Create and manage teams, assign users to teams, and control access levels.
Billing: Manage your billing plan and payment information.
Public Dashboard: Control visibility and content of your public-facing dashboard.
Embeddables: Generate embeddable markdown code for dynamic widgets to enhance your GitHub Readme and other platforms.
General Settings
Enable Pull Request Comments for achievements, XP, etc.
This setting allows the devActivity app to automatically post a summary comment on your GitHub Pull Requests (PRs) once they are merged. This comment includes valuable information like:
Cycle Time: The total time taken from PR creation to merging.
Coding Time: The time spent writing and testing code.
Pickup Time: The time taken for a reviewer to start reviewing.
Review Time: The time spent on code review.
Deploy Time (coming soon): The time taken for the code to be deployed (available soon).
Number of Comments: The total number of comments on the PR.
XP rewards per Contributor: The XP earned by each contributor for their work on the PR.
Why is this important?
Enabling this feature is crucial for Open Source projects as it significantly increases the engagement of first-time contributors. They get immediate feedback on their contributions and see the value they're bringing to the project.
Slack Integration
Integrate devActivity with your Slack workspace for seamless notifications and updates. Learn more about Slack integration.
Peer Feedback (Recognition Awards)
Enable this option to encourage a culture of appreciation within your team. Team members can nominate a colleague who deserves recognition for their contributions.
How it works: Team members receive weekly or monthly requests to nominate a teammate. They can select the teammate from a dropdown list and add a short comment explaining their choice.
Benefits: Fosters a positive work environment, encourages collaboration, and provides valuable insights into team dynamics.
Additional Analytics
Enable these options to access two additional reports in the Analytics section:
Contributors: Provides a detailed breakdown of individual contributor activity and performance metrics.
Discussions: Analyzes developer interactions and collaboration within the platform, such as forum posts and comments.
Note: These reports are automatically enabled for the Open Source plan.
Team/Users Management
This section allows you to:
Create and assign Teams: Organize your contributors into teams based on projects or functional areas.
Enable/disable access to devActivity for specific Org Contributors: Control who has access to the platform.
Invite External Managers: Grant access to individuals outside your GitHub organization who need access to devActivity features. This is useful for project managers, clients, HR managers, or C-level executives.
Note: External Managers must have a GitHub account.
Sync with GitHub: Ensure all contributors are properly synced with devActivity.
Core Features and Functionalities
1. Team Management
Creating Teams:
Select Team/Users.
Click on the + Add button to create a new team.
Enter a name for your new team.
You can optionally add a description for the team.
Click Save to create the team.
Editing Teams:
Click on the three dots next to the team name you want to edit.
Select Edit.
Modify the team name, description, or members.
Click Save to apply the changes.
Deleting Teams:
Click on the three dots next to the team name you want to delete.
Select Delete.
Confirm the deletion in the pop-up window.
Adding Users to Teams:
Go to the Team/Users section in the Settings menu.
Select the team you want to add users to.
Click on the + Add button.
Select the users you want to add from the dropdown list.
Click Save to add the users to the team.
2. User Roles and Permissions
Assigning Roles:
Navigate to the Team/Users section in the Settings menu.
Select the team you want to manage roles for.
Click on the three dots next to the user's name.
Select Edit.
Choose the desired role for the user from the dropdown list:
Org Admin: Full access to all settings, teams, and data.
Team Manager: Access to reports and settings for their assigned teams.
Org Contributor: Access to their individual reports and data.
Click Save to apply the changes.
3. User Management
Editing User Details:
Go to the Team/Users section in the Settings menu.
Click on the three dots next to the user's name.
Select Edit.
Modify the user's name, email address, or other details.
Click Save to apply the changes.
Deleting Users:
Go to the Team/Users section in the Settings menu.
Click on the three dots next to the user's name.
Select Delete.
Confirm the deletion in the pop-up window.
4. External Manager Invitations
Inviting External Managers:
Go to the Team/Users section in the Settings menu.
Click on the + Add button.
Select Invite External Manager.
Enter the email address of the external manager you want to invite.
Choose the team you want to grant access to.
Click Send Invitation.
Advanced Features
Filtering Teams and Users:
Use the search bar to filter teams or users by name.
You can also filter teams by type (e.g., Org Contributors, External Contributors).
Common Issues and Troubleshooting
User Cannot Access Team Data:
Ensure the user is assigned to the correct team.
Verify that the user has the appropriate permissions for their role.
Invitation Not Received:
Double-check the email address entered for the invitation.
Check the spam folder of the recipient's email account.
Resend the invitation if necessary.
Error Syncing Data:
Ensure that your devActivity app has the necessary permissions to access your GitHub repositories.
Try syncing data manually using the "Sync now" button in the General Settings section.
Best Practices and Use Cases
Organize Your Teams: Create teams based on project, function, or other relevant criteria to streamline communication and collaboration.
Assign Roles Effectively: Ensure that users have the appropriate permissions based on their responsibilities and access needs.
Use External Manager Invitations: Grant access to stakeholders outside your organization for specific projects or reports.
Regularly Review Teams and Users: Ensure that your team structure and user permissions are up-to-date and reflect current project needs.
Billing
Manage your billing plan and payment information. Learn more about billing options.
Public Dashboard
Configure the visibility and content of your public-facing dashboard. This dashboard can be shared with anyone and provides a read-only view of:
Top Contributors: A leaderboard of the most active members.
Achievements: A list of accomplishments earned by members.
Stats & Metrics: An overview of key performance indicators.
Learn more about the Public Dashboard.
Embeddables
Generate embeddable markdown code for various widgets to enhance your GitHub Readme and other platforms.
Learn more about embeddable widgets.
Recommendations
Engage Peer Feedback (Recognition Awards): Encourage your team to actively use the Recognition Award system to foster a culture of appreciation.
Enable Additional Analytics (Free/Premium plans): Gain deeper insights into contributor activity and discussions.
Configure Slack integration: Receive notifications and reports directly in your Slack workspace.
By configuring your devActivity settings effectively, you can create a more efficient, engaged, and rewarding development environment for your team.