codebase-review
v0.4.1
Published
A Node script that creates two branches - project and empty - that allow you to do a PR for an entire codebase.
Downloads
5
Readme
codebase-review
A handy command-line tool for reviewing an entire code base.
Usage
Usage:
npm i -g codebase-review
cd /your/repo
codebase-review
# If you want a prefix for your branch other than 'codebase-review', pass it in
codebase-review --prefix=github-code-review
Checking for Changes
By default, codebase-review
will not run if any changes have been made to HEAD
.
If you wish to force a review, run:
codebase-review --ignore-changes
How it works
- Create a completely empty orphan branch called
codebase-review-empty
- Create a copy of your master branch called
codebase-review-project
- Pushes both branches to your origin
Once both branches are pushed, make a Pull Request with the base set to codebase-review-empty
and the compare branch set to codebase-review-project
.
Tada! You can now review an entire code base.