https://github.com/larrylv/hound-gitlab

Hound for GitLab
https://github.com/larrylv/hound-gitlab

Last synced: about 2 months ago
JSON representation

Hound for GitLab

• Host: GitHub
• URL: https://github.com/larrylv/hound-gitlab
• Owner: larrylv
• License: mit
• Created: 2014-11-03T08:49:14.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-22T03:16:11.000Z (about 10 years ago)
• Last Synced: 2023-03-23T22:06:57.906Z (almost 2 years ago)
• Language: Ruby
• Homepage:
• Size: 2.2 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Hound-GitLab

=====

[![Build Status](https://travis-ci.org/larrylv/hound-gitlab.svg?branch=master)](http://travis-ci.org/larrylv/hound-gitlab?branch=master)

[![Code Climate](https://codeclimate.com/github/larrylv/hound-gitlab.png)](https://codeclimate.com/github/larrylv/hound-gitlab)

This project is originally a fork of [Hound](https://github.com/thoughtbot/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 →](https://github.com/thoughtbot/guides/tree/master/style)

## Configure Hound-GitLab on Your Local Development Environment

1. After cloning the repository, run the setup script `./bin/setup`

2. Log into your Gitlab account and go to the [Account Page](https://gitlab.com/profile/account).

3. 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.

4. Edit `GITLAB_ENDPOINT` and `HOST` in .env file.

5. Run `foreman start`. Foreman will start the web server, `redis-server`, and

   the resque background job queue.

Testing

-----------

1. Set up your `development` environment as per above.

2. Run `rake` to execute the full test suite.

Contributing

------------

First, thank you for contributing!

Here a few guidelines to follow:

1. Write tests

2. Make sure the entire test suite passes locally and on Travis CI

3. Open a pull request on GitHub

4. [Squash your commits](https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature) after receiving feedback

There a couple areas we would like to concentrate on.

1. Add support for JavaScript

2. Add support for CSS and Sass

3. Write [style guides](app/models/style_guide) that don't currently exist and

   would enforce the

   [thoughtbot style guide](https://github.com/thoughtbot/guides).