Contributing

Contributing to Hashview

We welcome and appreciate contributions from the community. There are many ways to become involved with Hashview: including filing issues, writing and improving documentation, and contributing to the code. Please read the rest of this document to ensure a smooth contribution process.

New to Git?

• Make sure you have a GitHub account.
• Learning Git:
  • GitHub Help: [Good Resources for Learning Git and GitHub][good-git-resources].
  • Git Basics: install and getting started.
• GitHub Flow Guide: step-by-step instructions of GitHub flow.

Setup development database

Note: double check your config/database.yml has correct settings

RACK_ENV=development rake db:create
RACK_ENV=development rake db:auto:migrate

Run Hashview in development mode:

RACK_ENV=development TERM_CHILD=1 QUEUE=* rake resque:work
RACK_ENV=development ruby main.rb

Destroying a databases

RACK_ENV=development rake db:destroy

Running tests

Performing the following within the test environment is preferred. However, you can run tests within any environment/database. Just make sure you've setup a test database using the same commands as above with RACK_ENV set to "test".

RACK_ENV=test rake test