Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 3.69 KB

README.markdown

File metadata and controls

79 lines (58 loc) · 3.69 KB

Overview

Barkeep is a fast, fun way to review code. Engineering organizations can use it to keep the bar high.

To see a video of Barkeep in action, visit getbarkeep.org.

Barkeep is standalone software that you host. Once it's set up, you can use it to track and code review any number of git repos available on the internet. It's designed to be easy to run on Ubuntu.

Getting started

If you're ready to install Barkeep, see the Installing Barkeep wiki page for instructions and a one-step shell script.

If you'd like to take Barkeep for a test-drive first or set up local development on your own machine you can quickly install it on a Vagrant VM. See the Vagrant wiki page for details.

Docs

See the wiki for instructions on setting up Barkeep for development, deploying it to your own server and tracking git repos with it.

Read here for a comparison of Barkeep to other code review systems.

Contributing

Barkeep was designed to be easy to hack on with Mac or Ubuntu, so feel free to dive in. You can open a ticket to suggest a new feature. If you fix a bug or implement a small feature, send us a pull request. If you want to implement a larger feature, please post a description of the feature on the mailing list beforehand so that we can be sure it's something we want to add.

Simple style guidelines: mimic the style around you, cap lines at 110 characters, and follow the usual conventions for commit messages.

Mailing list

Please file user issues as tickets here on Github.

The Barkeep developer mailing list is used for discussion around developing Barkeep. You can email the group at [email protected].

Credits

Barkeep was written by the following engineers at Ooyala:

and with contributions from other Ooyalans and community members:

Barkeep is released under the MIT license.