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: Provide Your GitHub Repository URL

Connect your GitHub repository by filling out the "Owner" and "Name" boxes. If connected correctly, a purple text box will appear providing you with the "about" text from your repository.

GitHub Repository

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.
GitHub Parameters

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.