Getting started

Get started

You need a GitHub account and write, maintain, or admin access to the repository. To review on GitHub, you also need an open pull request.

1. Open Arcanist and select Continue with GitHub.
2. Select Grant GitHub access and choose which repositories the GitHub App can access. Return to Arcanist and select Refresh repositories.
3. Choose a repository and start preparation. Arcanist installs the dependencies and sets up a private environment to run your code.
4. Open Reviews and choose a pull request. Select Review this PR when the repository is Ready. While it is still preparing, select Review when ready, and the review starts once preparation finishes.

You can also start a review by adding this comment to a pull request:

@tryarcanist /review

Read the result on GitHub or in Reviews. Check that the reviewed commit matches the code you plan to merge.

A review helps you decide what to fix. Keep your tests and CI checks, and review the evidence before you merge.