pmukerji / hound

Review your Ruby code for style guide violations with a trusty hound.

Hound

Take care of pesky code reviews with a trusty Hound.

Hound reviews GitHub pull requests for style guide violations. View the style guide →

Configure the Hound Service

We run Hound as a hosted service at houndci.com.

If you are setting up Hound for the first time, see the configuration page.

If you have questions about the service, see our FAQ or email [e-mail].

Configure Hound on Your Local Development Environment

1. After cloning the repository, run the setup script ./bin/setup
2. Log into your GitHub account and go to the Application Settings under Account settings.
3. Under the GitHub Developer Applications panel - Click on "Register new application"
4. Point ngrok to your local Hound instance: ngrok -subdomain=<your-initials>-hound 5000
5. Fill in the application details:

• Application Name: Hound Development
• Homepage URL: http://-hound.ngrok.com
• Authorization Callback URL: http://-hound.ngrok.com

6. On the confirmation screen, copy the Client ID and Client Secret to .env. Note the setup script copies .sample.env to .env for you, if the file does not exist.
7. Run foreman start. Foreman will start the web server, redis-server, and the resque background job queue. NOTE: rails server will not load the appropriate environment variables and you'll get a "Missing secret_key_base for 'development' environment" error.

Testing

1. Set up your development environment as per above.
2. Run rake to execute the full test suite.

Stripe

To test Stripe payments on staging use this fake credit card number.

Card	Number	Expiration	CVV
Visa	4242424242424242	Any future date	Any 3 digits

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 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 that don't currently exist and would enforce the thoughtbot style guide.

Contributor License Agreement

If you submit a Contribution to this application's source code, you hereby grant to thoughtbot, inc. a worldwide, royalty-free, exclusive, perpetual and irrevocable license, with the right to grant or transfer an unlimited number of non-exclusive licenses or sublicenses to third parties, under the Copyright covering the Contribution to use the Contribution by all means, including but not limited to:

• to publish the Contribution,
• to modify the Contribution, to prepare Derivative Works based upon or containing the Contribution and to combine the Contribution with other software code,
• to reproduce the Contribution in original or modified form,
• to distribute, to make the Contribution available to the public, display and publicly perform the Contribution in original or modified form.