Quickstart

The steps below detail how to get up and running with ReviewNinja, including a description of the basic workflow and the philosophy behind a ReviewNinja code review.

Add your repository

To add a repository to ReviewNinja hit to reveal the search dialog, here you may search for a repository.

To remove a repository, click .

Basic Workflow

ReviewNinja is a code review tool built for pull requests. We suggest adopting the Git Flow Workflow, but ReviewNinja can be adapted for any workflow as long as pull requests are used.

ReviewNinja provides two mechanisms for conducting code review. Ninja stars indicate approval, and review flags specify a specific problem that needs to be resolved before the pull request should be merged.

ProTip: ReviewNinja integrates well into the GitHub Flow.

Merge with Confidence

The Merge Pull Request button changes color to indicate the level of confidence in the merge.

Ignoring files

A .ninjaignore file specifies which files should be ignored by ReviewNinja. Each line specifies a file pattern, just like a .gitignore file.

Please note, ignored files will be minimized by default and still available for inspection in ReviewNinja.

Collaboration

Keep track of your team’s activity via the Team Tab. The Team Tab displays each collaborator and their contributions, including the number of ninja stars added, number of review threads opened, and the number of pull requests merged.

The Team Tab also allows you to invite repository collaborators to ReviewNinja.