This project is originally a fork of Hound by thoughtbot, and aims to support code reviews for GitLab.
Hound-GitLab reviews GitLab merge requests for style guide violations. View the style guide →
- After cloning the repository, run the setup script
./bin/setup
- Log into your Gitlab account and go to the Account Page.
- Copy the
Private token
to HOUND_GITLAB_TOKEN in.env
, and then fetch your userid with that token for HOUND_GITLAB_USERID(this is tricky, I know...) in .env file. Note the setup script copies.sample.env
to.env
for you, if the file does not exist. - Edit
GITLAB_ENDPOINT
andHOST
in .env file. - Run
foreman start
. Foreman will start the web server,redis-server
, and the resque background job queue.
- Set up your
development
environment as per above. - Run
rake
to execute the full test suite.
First, thank you for contributing!
Here a few guidelines to follow:
- Write tests
- Make sure the entire test suite passes locally and on Travis CI
- Open a pull request on GitHub
- Squash your commits after receiving feedback
There a couple areas we would like to concentrate on.
- Add support for JavaScript
- Add support for CSS and Sass
- Write style guides that don't currently exist and would enforce the thoughtbot style guide.