Skip to main content

GitHub Pull Requests

Using GitHub Pull Requests (PRs) as a source allows Kapa to pull PRs from your public GitHub repository. This allows Kapa to source information about ongoing development activities and the evolution of features. Additionally giving Kapa access to PRs ensures optimal support for relevant bugs other users might have experienced.

Step 1: Connect Your Repository​

  1. Go to the Sources tab on the Kapa platform and click on Add new source.

  2. Enter a name for the source, select GitHub Pull Requests, and click Continue.

  3. Specify the GitHub repository to use by filling in the Owner and Name fields.

  4. If it's a private repository, enter a personal access token for authenticating to GitHub. We recommend using a fine-grained access token.

    info

    The token must have access to the repository you're adding, with the following Repository permissions:

    • Contents: read-only
    • Discussions: read-only
    • Issues: read-only
    • Pull requests: read-only

If the connection is successful, a purple text box will appear providing you with the repository description.

Step 2: Configure Your GitHub PRs​

Once you've set up your repository you can configure a set of parameters in order to only provide Kapa with the GitHub PRs you find relevant.

  • Pull Request State: Defines whether or not Kapa should only ingest PRs that are open, closed or both and if PRs that were closed, but not merged should be excluded.
  • Pull Request Age: Defines the time limit of which PRs should be included in the ingestion, depending on their opening date.
  • Pull Request Labels: Defines what label(s) a PR should have in order to be included in the ingestion.

Tips & Tricks​

  • Don't Overdo PRs: When adding all historical PRs (open and closed) we've observed that it may add more noise than signal to Kapa.
  • Consider Adding Multiple Smaller PR Groups: Adding PRs is usually very project dependent. We've seen Type-Bug and Performance are usually quite high signal for Kapa to be aware of.
  • Limit To More Recent PRs: We've seen that the PRs that are most valuable are usually those than have been open/closed in the last 6-12 months. This varies widely for every project though.