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"
- Fill in the application details:
- Application Name: Hound Development
- Homepage URL: http://localhost:5000
- Authorization Callback URL: http://localhost:5000
- 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. - Generate the Stripe tokens and copy them into your
.env
file. Put the 'Test Secret Key' as the value forSTRIPE_API_KEY
and 'Test Publishable Key' as the value forSTRIPE_PUBLISHABLE_KEY
. - Create a Stripe plan called "private" for your development environment https://dashboard.stripe.com/test/plans
ID: "private" Name: "private"
- 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.