Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 63 lines (47 sloc) 2.225 kB
fbc9ee4 Get ready for initial release
Ryan Burrows authored
1 # Reviewr: Simple code review
11274bc Initial commit
Ryan Burrows authored
2
fbc9ee4 Get ready for initial release
Ryan Burrows authored
3 Reviewr is an application to simplify code review for projects using
4 git and github.com for version control.
5
6 # Installation
7 gem install reviewr
8
9 # Requesting a code review
10 reviewr request <email>
11 This will result in the following actions:
12
13 * Create a code review branch
14 * Create a commit with information about the code review request
15 * Push the code review branch to the origin repository
16 * Send an email to <email> requesting a code review of the branch
17 The email will include a link to Github's compare view for the
18 changes
19
20 ## Limitations
21
22 * Right now reviewr considers the origin/master the branch that the
23 reviewed code will be merged into when approved
24 * Email can only be sent from a Gmail (or Google Apps for my domain)
25 address
26
27 # TODO
28
29 ## Finish out the basic workflow
11274bc Initial commit
Ryan Burrows authored
30
31 General workflow goes something like this:
32
33 Code, code, code. Decide changes are ready for review and run `reviewr
34 request email@site.com`. This causes reviewr to:
35
36 * create a new branch with the name `review_0f38ef31` where `0f38ef31`
37 is the SHA of the current commit
38 * Add a commit to the branch with metadata about the request
39 (requester name/email etc).
40 * push the branch to the origin repository
a47f874 Generate a branch for the code review request
Ryan Burrows authored
41 * generate a github review url from the current head to the pushed
42 review branch
11274bc Initial commit
Ryan Burrows authored
43 * Send an email to `email@site.com` with a nice message and the url
44
45 The reviewer then looks over the code on github and comments as
46 necessary. If the code is acceptable the reviewer runs `reviewr accept
47 review_0f38ef31`. reviewr will then:
48
49 * fetch the review branch
50 * attempt to merge the reviewed branch into the master
51 * if it fails an error will be raised and execution will stop
52 * if is succeeds the merged master will be pushed
53 * the remote review branch will be deleted.
54 * an email will be sent to the review requester saying the code was accepted
55
56 If the code the reviewer is checking is not acceptable, upon finishing
57 comments on github the reviewer can run `reviewr reject
58 review_0f38ef31`. reviewr will:
59
60 * Re-generate the github url for comparing to the current master
61 * Send an email to the requester of the review saying the code has
62 been rejected and to please see the comments on the linked page
Something went wrong with that request. Please try again.