Take care of pesky code reviews with a trusty Hound.
Hound reviews GitHub pull requests for style guide violations. View the style guide โ
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 [email protected].
- After cloning the repository, run the setup script
./bin/setup
- Log into your GitHub account and go to the Application Settings under Account settings.
- Under the GitHub Developer Applications panel - Click on "Register new application"
- Point ngrok to your local Hound instance:
ngrok -subdomain=<your-initials>-hound 5000
- Fill in the application details:
- Application Name: Hound Development
- Homepage URL: http://-hound.ngrok.com
- Authorization Callback URL: http://-hound.ngrok.com
- On the confirmation screen, copy the
Client ID
andClient Secret
to.env
. Note the setup script copies.sample.env
to.env
for you, if the file does not exist. - 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 "Missingsecret_key_base
for 'development' environment" error.
- Set up your
development
environment as per above. - Run
rake
to execute the full test suite.
To test Stripe payments on staging use this fake credit card number.
Card | Number | Expiration | CVV |
---|---|---|---|
Visa | 4242424242424242 | Any future date | Any 3 digits |
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.
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.