Install and first review
Codzee is a GitHub app. Once it's installed, it reviews your pull requests on its own. Here's how to get going.
Install the GitHub app
- Install Codzee on GitHub, on your own account or your organization.
- Pick the repositories Codzee should review, or choose all of them. You can change this later on the same GitHub page.
- Sign in to the dashboard with GitHub. You'll see the repositories Codzee can review.
That's it. There are no config files to add and nothing to run. On Codzee Cloud, your 14-day free trial starts when you install, and you don't need a card.
Your first review
Open a pull request in one of the repositories you picked. Codzee reviews it within a few minutes and leaves comments on the lines that need attention, plus one summary comment.
Every time you push to the pull request, Codzee looks at the new commits. It doesn't repeat comments it has already made. Pull requests that only change docs or generated files are skipped.
Review an older pull request
Pull requests opened before you installed Codzee aren't reviewed automatically. To review one, comment on it:
@codzee reviewThis also works when you want a fresh review of any pull request. More in Talking to Codzee.
Where to see results
- On the pull request: comments on your code, a summary, and a check. See Reading a review.
- In the dashboard: every repository, its pull requests and what Codzee found. See The dashboard.
- In your Inbox: the pull requests waiting on you.
Can't find what you need? Email support@codzee.io and we'll help.