Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 1.72 KB

INSTALL.md

File metadata and controls

50 lines (39 loc) · 1.72 KB
Raw

Contributing to Future Kids

Looking forward to contribute to future kids? Then please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Here are some guidelines that needs to be followed:

Pre-requisite

  • Rails , preferable with rbenv wrapper
  • Postgresql
  • ImageMagick

Issue Tracker

  • Please be sure that you verify if there is any issue reported or fixed before reporting a new issue.
  • Please make sure that clear title and description is given while creating new issue.

Installation Instructions and Pull Requests

Please follow the below process to share your contribution via PR.

  1. Fork the repository, and configure the remotes: 
    # Clone your fork of the repo into the current directory
git clone https://github.com/panterch/future_kids.git
# Navigate to the newly cloned directory
cd future_kids
  2. After cloning, the ruby version is configured in .ruby-version, then its dependencies are installed as follows: 
    bundle install
bundle exec rake db:create 
bundle exec rake db:migrate 
bundle exec rake db:seed
bundle exec rails server
  3. Make your contributions.
  4. Open a Pull Request with clear title and description against the master branch.

Tests

  1. Initialize test db 
    bundle exec rake db:test:prepare
  2. Run specs 
    bundle exec rspec

Note: It would be great to have an automated tests included and running test suite.