Contributing.md

February 3, 2015 ยท View on GitHub

[ Back to TheRole ]

Contributing

0. Prepare folder

mkdir -p ~/my/gems/TheRole
cd ~/my/gems/TheRole

1. Clone projects

git clone git@github.com:TheRole/DummyApp.git
git clone https://github.com/TheRole/the_role_api
git clone https://github.com/TheRole/the_role_management_panel

File browser in your Editor can looks like this

TheRole. Authorization gem for Ruby on Rails with Administrative interface

2. Move to DummyApp

cd ~/my/gems/TheRole/DummyApp

3. Change Gemfile

Link DummyApp with local gems

gem 'the_role_api',
  path: '../the_role_api'

gem 'the_role_management_panel',
  path: '../the_role_management_panel'

4. Bundle and test!

bundle

RAILS_ENV=test rake db:bootstrap
RAILS_ENV=test rspec --format documentation

5. Move to gem which you want to improve

cd ~/my/gems/TheRole/the_role_api

6. Create new branch with feature

git checkout -b "mongo_version"

7. Make some magic

Write code, have fun! You can see your results in DummyApp

8. Test your feature

Test new code with DummyApp specs

cd ~/my/gems/TheRole/DummyApp

RAILS_ENV=test rspec --format documentation

9. Pull Request

Send a Pull Request =)

[ Back to TheRole ]