​
Getting started with Diamond

Diamond can be enabled in just a few clicks, with no configuration required to start catching bugs in your pull requests.

​
Enabling Diamond

  1. Navigate to the Diamond settings page
  2. Click “Enable Diamond”
  1. Select the repositories you want Diamond to analyze
    • You can choose specific repositories or enable Diamond across your entire organization
    • If you don’t see the repositories you’re looking for, make sure they’re synced with Graphite
  1. That’s it! Diamond will now automatically review all new pull requests in the selected repositories

​
What happens next

Once enabled, Diamond:
  • Automatically analyzes new pull requests in the selected repositories
  • Comments directly on pull requests when it finds potential issues
  • Suggests fixes for the problems it identifies
Diamond works behind the scenes, with no changes required to your existing PR workflow. Your team can continue using GitHub just as they do today, with Diamond providing additional feedback alongside human reviewers. For teams using continuous integration, Diamond works alongside your test suite to catch issues that tests often miss, like logic bugs, edge cases, and security vulnerabilities.

​
Enabling Diamond on personal repositories

In order to enable Diamond on your personal repositories, you must first install the Graphite GitHub App on your personal account.
  1. Navigate to your GitHub authentication settings page
  1. If this is your first time authenticating Graphite using the GitHub App, select the “Install GitHub App” button; otherwise, select the “Add organization” button.
  2. Install the Graphite GitHub App using the pop-up window that appears, selecting your personal account’s login.
  1. After returning to the GitHub authentication settings page, click the “Join team” button next to your personal account’s login.
After completing these steps, you can enable Diamond on your personal account following the instructions for Getting started with Diamond.
You can only enable Diamond on personal repositories that you own.

​
Advanced configuration

While Diamond works great out of the box, you can customize it to better fit your team’s workflow and standards. See our Customization page for details on:
  • Setting up exclusions to prevent Diamond from commenting on certain types of issues
  • Creating custom rules that match your team’s coding guidelines
  • Excluding files from Diamond’s analysis