Skip to content

HTTPS clone URL

Subversion checkout URL

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