How to Use Graphite

Getting started with Graphite

In this guide, you'll learn how to set up Graphite for AI-powered code reviews and manage stacked pull requests effectively. By the end, you’ll be able to streamline your code review process and merge changes faster.

Step 1: Sign up and set up

1. Go to the Graphite website.
2. Click on the Sign Up button in the top right corner.
3. Enter your email address and create a password, or sign up using your GitHub account for quicker access.
4. Confirm your email if prompted, and log in to your new account.

Step 2: Your first pull request review

1. Once logged in, navigate to your Dashboard.
2. Click on the New Pull Request button.
3. Select the repository you want to review and choose the branches to create your pull request.
4. Add a title and description for your pull request, then click Create.
5. To add more pull requests to your stack, repeat the above steps for each additional request.
6. When ready, click on Review Stacked Pull Requests to start the review process.
7. Use the AI suggestions to improve your code by clicking on the AI Review button, which will provide feedback on your changes.

Step 3: Get better results

1. Use clear, descriptive titles and comments in your pull requests. This helps the AI understand the context better.
2. Regularly check the Insights tab on your dashboard for metrics on your code quality and review speed.
3. Experiment with the Review Settings found in your account settings to adjust how the AI assesses your code, such as enabling or disabling specific checks.

Pro tip

Many beginners overlook the Batch Review feature. When reviewing stacked pull requests, make sure to use this option to quickly assess multiple changes at once, saving you time and effort.

Common mistake to avoid

Avoid creating too many pull requests at once without clear organisation. This can lead to confusion during the review process. Instead, group related changes logically and provide context in your descriptions to make reviews smoother.