Getting Started with grooveASSIGN¶
Get automated PR reviewer assignment in under 5 minutes.
Install the GitHub App¶
- Visit github.com/apps/grooveassign
- Click Install
- Select the organization or repositories you want to enable
- Grant the required permissions
Required Permissions¶
- Repository: Write access (to assign reviewers)
- Pull requests: Write access (to modify PR reviewers)
- Organization members: Read access (to check team membership)
Configuration (Optional)¶
Create .codeGROOVE/assigner.yaml in any repository in your organization:
min_grace_period: 2 # Minutes before assignment
pending_test_grace: 20 # Minutes while tests pending
failing_test_grace: 90 # Minutes while tests failing
max_reviewers: 2
max_prs_per_reviewer: 9
excluded_users:
- bot-account
excluded_paths:
- "vendor/**"
- "**/*.generated.go"
See Configuration for all available options.
Verify Installation¶
- Open a new PR without requesting reviewers
- Wait for the grace period (default: 2 minutes)
- grooveASSIGN will automatically assign reviewers based on code ownership
Next Steps¶
- Configuration - Customize assignment behavior