NameDateSize

..16-Mar-201612 KiB

.gitignore07-Aug-2015801

.reviewboardrc02-Feb-2015225

AUTHORS09-Dec-20154.5 KiB

contrib/17-Aug-20134 KiB

CONTRIBUTING25-Mar-2013397

COPYING29-Dec-20121.1 KiB

dev-requirements.txt09-Nov-201575

docs/07-Feb-20124 KiB

ez_setup.py29-Dec-201210 KiB

INSTALL29-Dec-2012145

MANIFEST.in17-Jun-2015448

NEWS08-Jul-2014193

README.rst09-Dec-20157.1 KiB

reviewboard/14-Dec-20154 KiB

setup.cfg02-Jan-2015277

setup.py14-Dec-20158.2 KiB

README.rst

1Review Board
2============
3
4`Review Board`_ is an open source, web-based code and document review tool
5built to help companies, open source projects, and other organizations keep
6their quality high and their bug count low.
7
8We began writing Review Board in 2006 to fill a hole in the code review market.
9We wanted something open source that could be flexible enough to work with a
10variety of workflows, and could take the pain out of the code review process.
11
12Today, it's a vital part of the development process at thousands of projects
13and companies, ranging from small startups of two people to enterprises of
14thousands.
15
16.. _`Review Board`: https://www.reviewboard.org/
17
18
19What does Review Board do?
20--------------------------
21
22Review Board tracks changes to your pending code, graphics, documents, and all
23discussions around all the decisions made about your product. Our diff viewer
24does more than just display diffs: It shows you exactly how your code was
25changed, with syntax highlighting, interdiffs, moved line detection,
26indentation change indicators, and more.
27
28You can integrate with Review Board using its rich API and extension
29frameworks, allowing custom features, review UIs, data analysis, and more to be
30built without ever having to fork Review Board.
31
32There's support for Bazaar, ClearCase, CVS, Git, Mercurial, Perforce, Plastic,
33and Team Foundation Server, hosted on your own server or on Assembla,
34Beanstalk, Bitbucket, Codebase, GitHub, GitLab, Gitorious, Kiln, or Unfuddle.
35
36To learn more, visit the `Review Board website`_.
37
38.. _`Review Board website`: https://www.reviewboard.org/
39
40
41Setting up Review Board
42-----------------------
43
44First, `get Review Board <https://www.reviewboard.org/get/>`_. Our helpful
45interactive guide will walk you through what you need to download and install
46Review Board.
47
48We can also host Review Board for you at RBCommons_. Management is simple,
49and we'll take care of all the administrative work.
50
51If you want to get a feel for Review Board, check out the demo_.
52
53For additional information, see our documentation:
54
55* `Review Board User Manual`_
56* `Review Board Administration Manual`_
57* FAQ_
58
59.. _RBCommons: https://rbcommons.com/
60.. _demo: http://demo.reviewboard.org/
61.. _`Review Board User Manual`:
62   https://www.reviewboard.org/docs/manual/latest/users/
63.. _`Review Board Administration Manual`:
64   https://www.reviewboard.org/docs/manual/latest/admin/
65.. _FAQ: https://www.reviewboard.org/docs/manual/latest/faq/
66
67
68Installing Power Pack
69---------------------
70
71`Power Pack`_ extends Review Board, adding such helpful features as:
72
73* `Report generation`_
74* `PDF document review`_
75* Better multi-server scalability
76* Integration with `Microsoft Team Foundation Server`_
77* Integration with `GitHub Enterprise`_
78* LDAP/Active Directory user sync (coming soon)
79
80To get started, `download a trial license`_, or read the
81`Power Pack documentation`_ for more information.
82
83.. _`Power Pack`: https://www.reviewboard.org/powerpack/
84.. _`Report generation`:
85   https://www.reviewboard.org/docs/powerpack/latest/powerpack/manual/reports/
86.. _`PDF document review`:
87   https://www.reviewboard.org/docs/powerpack/latest/powerpack/manual/pdf/
88.. _`Microsoft Team Foundation Server`:
89   https://www.visualstudio.com/en-us/products/tfs-overview-vs.aspx
90.. _`GitHub Enterprise`: https://enterprise.github.com/
91.. _`download a trial license`: https://www.reviewboard.org/powerpack/trial/
92.. _`Power Pack documentation`:
93   https://www.reviewboard.org/docs/powerpack/latest/
94
95
96Installing RBTools
97------------------
98
99If you're an end-user already using Review Board, you'll want to install
100RBTools, our command line suite for working with Review Board.
101
102RBTools makes it easy to post changes for review, land reviewed changes,
103patch your local tree with someone else's changes, check your workload, and
104much more.
105
106RBTools can be `installed <https://www.reviewboard.org/downloads/rbtools/>`_
107on Windows, Linux, Mac, and other platforms. See the `RBTools documentation`_
108for everything it can do.
109
110.. _`RBTools documentation`: https://www.reviewboard.org/docs/rbtools/latest/
111
112
113Getting Support
114---------------
115
116We can help you get going with Review Board, and diagnose any issues that may
117come up. There are two levels of support: Public community support, and private
118premium support.
119
120The public community support is available on our main `discussion list`_. We
121generally respond to requests within a couple of days. This support works well
122for general, non-urgent questions that don't need to expose confidential
123information.
124
125We can also provide more
126`dedicated, private support <https://www.beanbaginc.com/support/contracts/>`_
127for your organization through a support contract. We offer same-day responses
128(generally within a few hours, if not sooner), confidential communications,
129installation/upgrade assistance, emergency database repair, phone/chat (by
130appointment), priority fixes for urgent bugs, and backports of urgent fixes to
131older releases (when possible).
132
133.. _`discussion list`: https://groups.google.com/group/reviewboard/
134
135
136Our Happy Users
137---------------
138
139There are thousands of companies and organizations using Review Board today.
140We respect the privacy of our users, but some of them have asked to feature them
141on the `Happy Users page`_.
142
143If you're using Review Board, and you're a happy user,
144`let us know! <https://groups.google.com/group/reviewboard/>`_.
145
146
147.. _`Happy Users page`: https://www.reviewboard.org/users/
148
149
150Reporting Bugs
151--------------
152
153Hit a bug? Let us know by
154`filing a bug report <https://www.reviewboard.org/bugs/new/>`_.
155
156You can also look through the
157`existing bug reports <https://www.reviewboard.org/bugs/>`_ to see if anyone
158else has already filed the bug.
159
160
161Contributing
162------------
163
164Are you a developer? Do you want to integrate with Review Board, or work on
165Review Board itself? Great! Let's help you get started.
166
167First off, we have a few handy guides:
168
169* `Web API Guide`_
170* `Extending Review Board`_
171* `Contributor Guide`_
172
173We accept patches to Review Board, RBTools, and other related projects on
174`reviews.reviewboard.org <https://reviews.reviewboard.org/>`_. (Please note
175that we do not accept pull requests.)
176
177Got any questions about anything related to Review Board and development? Head
178on over to our `development discussion list`_.
179
180.. _`Web API Guide`: https://www.reviewboard.org/docs/manual/latest/webapi/
181.. _`Extending Review Board`:
182   https://www.reviewboard.org/docs/manual/latest/webapi
183.. _`Contributor Guide`: https://www.reviewboard.org/docs/codebase/dev/
184.. _`development discussion list`:
185   https://groups.google.com/group/reviewboard-dev/
186
187
188Related Projects
189----------------
190
191* Djblets_ -
192  Our pack of Django utilities for datagrids, API, extensions, and more. Used
193  by Review Board.
194* RBTools_ -
195  The RBTools command line suite.
196* ReviewBot_ -
197  Pluggable, automated code review for Review Board.
198* rb-gateway_ -
199  Manages Git repositories, providing a full API enabling all of Review Board's
200  feaures.
201
202.. _Djblets: https://github.com/djblets/djblets/
203.. _RBTools: https://github.com/reviewboard/rbtools/
204.. _ReviewBot: https://github.com/reviewboard/ReviewBot/
205.. _rb-gateway: https://github.com/reviewboard/rb-gateway/
206