Getting started

Quick start

Setup takes about ten minutes. You need admin rights on the git repositories you want Nudge to watch, and permission to add apps to your Slack workspace.

  1. Create your workspace

    Sign in at app.nudgepr.dev. Your first sign-in creates a workspace, and you’re its owner.

  2. Connect your git host

    Install the GitHub App, or connect a self-hosted Gitea with an access token. See Connecting GitHub and Gitea.

  3. Connect Slack

    Add Nudge to Slack so it can message reviewers directly and post to your channels. See Connecting Slack.

  4. Pick repositories and channels

    On Repositories, turn on the repositories Nudge should watch (or Monitor all) and pick the Slack channel each one posts to.

  5. Build a reviewer pool

    On Reviewer pools, add the people who review each repository. Nudge takes turns between them when a pull request doesn’t already request someone. See Reviewer pools.

  6. Check the nudge policy

    The Standard policy works for most teams. Change the timing, working hours or what happens when a review stalls on Nudges. See Nudges and escalation.

  7. Invite your team

    Invite people on Members so they can see their own reviews on My reviews. See Members and access.