crisco-readme.md

crisco

Code Reviews hosted In github COmments' COmmits

Installation

Usage

Setup

Go to http://your-crisco.heroku.com and authorize it to access your Github profile. Add webhook http://your-crisco.heroku.com to yours repo.

Group setup

If you need crisco to send commit requests and commit disscussion into your maillist, set MAILLIST_EMAIL enviroment variable:

Requests for review

Commit to your repo. You can indicate that you would like your collegues to review this commit by:

• #reviewthis @friendname @friendname2 in commit message
• #reviewthis @friendname @friendname2 in commit comment (on Github) - it is not saved in repo, it does not pollute your repo.

Reviewing

You can review commits by:

• Adding comments to commit (on Github)
• Responding to maillist email (If you have maillist setup) - comments appear on Github

Crisco command-line helper

crisco is command line utility to help to interact with crisco review system

Installation

npm install -g crisco

Setup

Usage

Request review of last commit (its not going to put request into commit message, instead its going put it into commit comment on Github, without polluting of repo):

crisco req

Request review of specific commit:

crisco req cfc4c7231261498805d4106ef1cc27eca75edeb1

Support for pre-push reviews

If last (or requested to review) commit is not pushed to origin remote, crisco will:

• Create remote branch _code_review-{commit branch}-{commit hash}
• Push commit to that branch
• Request review of commit

Once commit is pushed to non-_code_review prefixed branch, crisco server-side installation will remove temporary branch.