Skip to main content

Your first review

Gryndel reviews merge requests (GitLab) and pull requests (GitHub) in the repositories your workspace admins have turned on. This page takes you through a review from start to finish, so you know what to expect before Gryndel comments on your team's real work.

1. Check that your repository is reviewed​

In Gryndel, open Repositories. Find your repository and look at the Reviews column. If it doesn't say Enabled, ask a workspace admin to turn it on, or do it yourself if you're an admin (see Turn on repositories).

2. Open a merge or pull request​

Open one as you normally would:

Push a branch and create the merge request, or edit a file in GitLab's web editor and choose Start a new merge request.

To see Gryndel find something, include a small, obvious bug. For example:

def average(values):
    return sum(values) / (len(values) - 1)

Use a draft or a scratch branch if you don't want teammates notified.

3. Watch Gryndel work​

  • Within a few seconds, a progress comment appears on the merge or pull request. On GitLab it comes from the user Gryndel; on GitHub, from your organisation's Gryndel App, shown as <name>[bot].
  • In Gryndel, the review appears on the Pull requests page while it runs. Open it to follow each step, or click View in GitLab (or View in GitHub) to go back. See Pull requests.
  • After a few minutes, Gryndel posts a summary and a comment for each finding. On GitHub, findings are review comments on the changed lines, often with a suggested change.

Then try a command. Add this comment to the merge or pull request:

@gryndel help
On GitHub

GitHub doesn't autocomplete @gryndel or notify anyone, because an App can't be mentioned. Gryndel watches for the word itself, so type it in full. Commands work for people with write access to the repository (on GitLab: the Developer role or higher).

Talking to Gryndel lists every command, and Reading a review explains what Gryndel posts.

Nothing happened?​

Comment @gryndel status on the merge or pull request. If Gryndel doesn't answer, see Troubleshooting: a review never starts.

Models make mistakes

AI reviews can miss bugs or describe them imperfectly. Treat findings as a colleague's opinion. Dismiss wrong ones with @gryndel ignore this, so Gryndel and your admins can see what wasn't useful.