Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 84 lines (59 sloc) 2.592 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
3b916b7 @rhburrows Update README documentation
authored
9 # Usage
10
11 Reviewr is designed to simplify code reviews for projects that revolve
12 around a single 'master' repository with multiple contributors (i.e. a
13 project that is hosted on github). It does this by providing a default
14 work-flow that all developers can use.
15
16 The general work-flow (at the moment) is:
17
18 1. The coder issues a code review request through the 'request'
19 command.
20 2. The reviewer(s) review the code and comment on it through github
21 3. If the code is good enough to merge it can be pulled into the
22 master branch through the 'accept' command
23
24 While this documentation is up to date (as of version 0.2.0) I am
25 still experimenting with an ideal work-flow for these type of code
26 reviews, so this code is subject to heavy change. If you have any
27 suggestions send me an email or comment in the issue tracker as I
28 would love further opinions.
29
30 ## Requesting a code review
fbc9ee4 Get ready for initial release
Ryan Burrows authored
31 reviewr request <email>
32 This will result in the following actions:
33
34 * Create a code review branch
35 * Create a commit with information about the code review request
e652195 Clean up
Ryan Burrows authored
36 * Push the code review branch to the remote repository
fbc9ee4 Get ready for initial release
Ryan Burrows authored
37 * Send an email to <email> requesting a code review of the branch
38 The email will include a link to Github's compare view for the
375fda7 @rhburrows Bump version to start prep for next release
authored
39 changes
40
3b916b7 @rhburrows Update README documentation
authored
41 ## Accepting changes from a code review
375fda7 @rhburrows Bump version to start prep for next release
authored
42 reviewr accept <branch_name>
43 This will result in the following actions:
44
45 * Create a branch for the reviewed code
46 * Rebase the reviewed code on the current branch
47 * Merge in the commits
48 * Push the merged branch
49 * Delete the code review branch from the remote repo
50 * Send an email to the requester of the review saying the changes have been
51 merged
fbc9ee4 Get ready for initial release
Ryan Burrows authored
52
3b916b7 @rhburrows Update README documentation
authored
53 # Contributing
fbc9ee4 Get ready for initial release
Ryan Burrows authored
54
3b916b7 @rhburrows Update README documentation
authored
55 ## Reporting Bugs
fbc9ee4 Get ready for initial release
Ryan Burrows authored
56
3b916b7 @rhburrows Update README documentation
authored
57 Bugs are being managed using Github's issue tracking
fbc9ee4 Get ready for initial release
Ryan Burrows authored
58
3b916b7 @rhburrows Update README documentation
authored
59 http://github.com/rhburrows/reviewr/issues
11274bc Initial commit
Ryan Burrows authored
60
3b916b7 @rhburrows Update README documentation
authored
61 ## Contributing Code
11274bc Initial commit
Ryan Burrows authored
62
3b916b7 @rhburrows Update README documentation
authored
63 Just fork the project on github and submit a pull request
11274bc Initial commit
Ryan Burrows authored
64
3b916b7 @rhburrows Update README documentation
authored
65 http://github.com/rhburrows/reviewr
11274bc Initial commit
Ryan Burrows authored
66
3b916b7 @rhburrows Update README documentation
authored
67 # TODO
11274bc Initial commit
Ryan Burrows authored
68
3b916b7 @rhburrows Update README documentation
authored
69 ## Add a reject code review command
11274bc Initial commit
Ryan Burrows authored
70
71 If the code the reviewer is checking is not acceptable, upon finishing
72 comments on github the reviewer can run `reviewr reject
73 review_0f38ef31`. reviewr will:
74
75 * Re-generate the github url for comparing to the current master
76 * Send an email to the requester of the review saying the code has
77 been rejected and to please see the comments on the linked page
3b916b7 @rhburrows Update README documentation
authored
78
79 # Limitations
80
81 * Email can only be sent from a Gmail (or Google Apps for my domain)
82 address
83 * Only tested with git 1.7.0
Something went wrong with that request. Please try again.