README Developers

contribution guidelines

ATTN: ADMINS - plz review these and/or add your own - following are some reasonable suggestions i would reccommend for keeping the project on track -->

• be DRY and OOP where ever possible
• use ruby code conventions (two space indents, underscore variable names , question mark boolean methods, etc)
• all rspec and cucumber tests should be passing green before commtting
• there should exist tests excersizing all new functionality
• the first line of commit messages should generally be brief and concise (< ~60 characters)
• commits bulding toward distinct features should be in separate pull requests (use feature branches)
• it should be clear from the extended commit message and pull request discussion as to which feature each commit is bulding toward

installing tip4commit on GNU/linux

• fork this repo on github and clone your fork

    git clone https://github.com/YOUR_GITHUB_NICK/tip4commit.git
    cd ./tip4commit

• copy the config skeletons

    cp ./config/config.yml.sample   ./config/config.yml
    cp ./config/database.yml.sample ./config/database.yml

• to allow registrations without configuring the mailer you can comment out the devise :confirmable module requirement in app/models/user.rb (be sure to uncomment it again before you commit)

  devise :database_authenticatable, :registerable, :recoverable,
         :rememberable, :trackable, :validatable # , :confirmable

• setup the rails environmaent (NOTE: Gemfile is currently requiring ruby 2.0.0)

    bundle install --without production
    bundle exec rake db:migrate
    bundle exec rake db:test:prepare

• all rspec and cucumber tests should be passing green - open an issue if they are not

    bundle exec rake spec
    bundle exec rake cucumber