Configuration

Customize Nudgy Bot to match your team's workflow using the intuitive Home Tab interface. No commands to remember, no manual configuration files.

Accessing Configuration

All configuration happens in the Slack Home Tab:

  1. In Slack, search for @Nudgy Bot
  2. Click on the bot name
  3. Click the Home tab at the top
  4. You'll see all your organizations and repositories organized beautifully

Repository Mapping

Map GitHub repositories to Slack channels to control where notifications are sent.

Add a Repository

  1. In the Home Tab, find your GitHub organization
  2. Click "Add Repository from [Org Name]"
  3. Select a repository from the dropdown (shows only authorized repos)
  4. Choose which Slack channel receives notifications
  5. Click "Add Repository"

Edit a Repository

  1. Find the repository in your Home Tab
  2. Click the "Edit" button
  3. Update channel, reminder timing, or weekly stats settings
  4. Click "Save"

Remove a Repository

  1. Click "Edit" on the repository
  2. Scroll to the bottom of the modal
  3. Click "Remove Repository"
  4. Confirm the removal

Reminder Configuration

Each repository has its own reminder schedule. Configure when and how often the bot sends PR reminders.

Default Schedule

By default, reminders are sent at these times after PR opens:

  • 1st Reminder: 1 hour after PR opens
  • 2nd Reminder: 4 hours after PR opens
  • 3rd Reminder: 10 hours after PR opens
  • 4th Reminder: 34 hours after PR opens
  • 5th+ Reminders: Every 24 hours after that

Custom Timing

To customize reminder timing for a specific repository:

  1. Click "Edit" on the repository in the Home Tab
  2. Scroll to the "Reminder Timing" section
  3. Enter absolute hours from PR creation for each reminder (e.g., 1, 4, 10, 34)
  4. For "5th+ Reminders Interval", enter how often to repeat (e.g., 24 for daily, 12 for twice daily)
  5. Click "Save"

πŸ’‘ Note: Changes apply to new PRs only. Existing open PRs keep their current schedule.

Weekly Statistics

Get weekly summaries of your team's PR activity per repository, including review times, merged PRs, and top contributors.

Enabling Weekly Stats

  1. In the Home Tab, click "Edit" on a repository
  2. Check "Enable Weekly Stats"
  3. Select the day (e.g., Friday)
  4. Enter the time in 24-hour format (e.g., 17:00)
  5. Click "Save"

On-Demand Stats

Don't want to wait for the weekly schedule? Get stats instantly:

  • Click "πŸ“ˆ This Week's Stats" next to any repo
  • Click "πŸ“Š Last Week's Stats" for previous week
  • Stats are posted to the repository's configured channel

What's Included

  • Total PRs opened and merged
  • Average review time
  • Top reviewers leaderboard (πŸ₯‡πŸ₯ˆπŸ₯‰)
  • Review participation rate

GitHub Organizations

Manage your GitHub App installations and organization links.

Link an Organization

  1. In the Home Tab, click "Add Organization"
  2. You'll be redirected to GitHub
  3. Select the organization or personal account
  4. Choose which repositories to authorize
  5. After installation, you're automatically redirected back
  6. Your Home Tab refreshes with the new organization

Unlink an Organization

  1. Go to GitHub β†’ Settings β†’ Applications
  2. Find "Nudgy Bot" in Installed GitHub Apps
  3. Click "Configure" then "Uninstall"
  4. All repositories from that org are automatically removed from your Slack

Organization Admins

Delegate repository and configuration management to specific team members without giving them full workspace admin privileges.

What Org Admins Can Do

  • Add, edit, and remove repositories from their assigned organization
  • Configure reminder timing and weekly stats for repos in their org
  • Manage user mappings (GitHub ↔ Slack) for their org
  • View on-demand stats for repositories

Adding Organization Admins

  1. (Only workspace admins can manage org admins)
  2. In the Home Tab, find the GitHub organization
  3. Click "Manage Org Admins"
  4. Search for and select team members to add
  5. Click "Add Org Admins"

Removing Org Admins

  1. Click "Manage Org Admins" for the organization
  2. Click the "βœ•" button next to a user's name
  3. They'll immediately lose admin access to that organization

πŸ’‘ Note: If a user is deactivated or removed from the workspace, they're automatically removed from all org admin roles.

User Mapping (GitHub ↔ Slack)

Map GitHub usernames to Slack users so reviewers are properly mentioned in PR notifications and reminders.

Automatic Mapping

Nudgy Bot automatically tracks GitHub users who interact with PRs (authors, reviewers, commenters) and prompts you to map them to Slack users.

Manual Mapping

  1. In the Home Tab, find a repository
  2. Click "πŸ‘€ Map Users"
  3. You'll see a list of unmapped GitHub users
  4. Select the corresponding Slack user for each GitHub username
  5. Click "Save Mappings"

Why It Matters

  • Reviewers receive proper @mentions in Slack
  • Weekly stats show accurate leaderboards with Slack names
  • Unmapped users appear as plain text (not clickable mentions)

Pause & Resume Reminders

Temporarily stop reminders for a specific PR without closing it.

Pausing Reminders

  1. In the channel, find the PR notification
  2. Click "⏸ Cancel All Reminders"
  3. All future reminders for that PR are stopped

Resuming Reminders

  1. Click "▢️ Resume Reminders" on the same message
  2. Reminders restart from where they left off

πŸ’‘ Note: When a PR is reopened or a new review is requested, reminders automatically resume.

Repository-Specific Labels

Optionally configure specific GitHub labels to watch. When set, only PRs with these labels will trigger notifications and reminders.

Configuring Labels

  1. Click "Edit" on a repository in the Home Tab
  2. Scroll to "Repository Labels" section
  3. Enter labels to watch (e.g., needs-review, high-priority)
  4. Click "Save"

Behavior

  • No labels configured: All PRs are tracked
  • Labels configured: Only PRs with at least one matching label are tracked
  • Label removed: Reminders stop for that PR

πŸ—‘οΈ Uninstalling Nudgy Bot

There are two ways to remove Nudgy Bot, depending on what you want to uninstall.

Option 1: Delete a Specific GitHub Organization

Use this if you want to remove one organization but keep Nudgy Bot for others.

  1. (Only workspace admins can delete organizations)
  2. In the Home Tab, find the GitHub organization you want to remove
  3. Click the πŸ—‘οΈ Delete button
  4. Read the warning and confirm deletion

⚠️ What Gets Deleted:

  • GitHub App is uninstalled from your GitHub organization
  • All repositories, PRs, reminders, and stats are removed from Slack
  • All org admin assignments and user mappings are deleted

πŸ”„ What If GitHub Uninstall Fails?

If you already uninstalled the GitHub App manually (while the bot was offline), the Delete button will still clean up all Slack data. You'll see a "Partial Success" message confirming the cleanup and suggesting to verify the GitHub App was removed from your GitHub organization settings.

Option 2: Completely Remove Nudgy Bot from Slack

Use this if you want to completely uninstall the bot from your Slack workspace.

  1. (Only workspace admins can uninstall apps)
  2. In Slack, go to Settings β†’ Manage apps
  3. Search for "Nudgy Bot"
  4. Click on the app, then click "Configuration"
  5. Scroll down and click "Remove App"
  6. Confirm the removal

🚨 Complete Uninstall:

  • All GitHub organizations, repositories, and configurations are deleted
  • All PR reminders, stats, and user mappings are permanently removed
  • The bot is removed from all Slack channels
  • This does NOT automatically uninstall the GitHub App β€” you'll need to manually uninstall it from GitHub β†’ Settings β†’ Applications β†’ Installed GitHub Apps

πŸ“ Recommended Uninstall Order

For the cleanest uninstall experience:

  1. First: Delete each GitHub organization using the πŸ—‘οΈ Delete button in the Home Tab (this uninstalls the GitHub App automatically)
  2. Then: Remove the Nudgy Bot app from Slack using Slack's "Manage apps" settings

πŸ’‘ This ensures both GitHub and Slack are cleanly uninstalled without leaving orphaned data.

Tips & Best Practices

  • πŸ’‘ Organize by team: Use different Slack channels for frontend, backend, and mobile repos
  • ⏰ Adjust timing: Fast-moving teams might want shorter intervals (30min, 1h, 2h)
  • πŸ“Š Enable stats: Weekly stats help identify bottlenecks and celebrate top reviewers
  • πŸ”„ Auto-refresh: Home Tab automatically updates after changesβ€”no manual refresh needed