DocsQuickstart: code review
Docs/Get started

Quickstart: code review

Get your first Anvil review in about two minutes. You need an Anvil account and a repository on GitHub, or one on Anvil.

  1. Open Settings → Repositories and click Install on GitHub.

    The Add repositories panel in Settings → Repositories

  2. On GitHub, pick your account or organisation, then All repositories or Only select repositories, and click Install.

  3. Open a pull request in one of those repositories, or comment on one you already have:

    @anvil review
    
  1. Open Code → New repository, give it a name and leave Review pull requests on.

  2. Push a branch to it:

    bash
    git push -u origin my-change
    
  3. Open a pull request from the repository's Pull requests tab.

You're done #

In a few minutes the pull request has:

  • a walkthrough comment: a summary, the change split into layers, a sequence diagram, the review effort and the risk;
  • inline comments, one per finding, each with a severity, an explanation and a suggested fix;
  • an Anvil commit status on the head commit.

Each later push gets a review of only the new commits. The review also appears under Pull requests in Anvil, where the workspace shows the change layer by layer.

Next #