-
Clone your repo.
git clone git@github.com:USERNAME/planner.git cd planner -
Setup & start the application.
bundle rake db:create db:migrate db:seed rails server -
Have a look around to get a feel for the app.
-
Run the tests. We only take pull requests with passing tests, and it's great to confirm that you have a clean slate.
rake -
Add a test for your change - unless you are refactoring or adjusting styles and documentation. If you are adding any functionality or fixing a bug, we need a test!
-
Implement your change and ensure all the tests pass.
-
Run Rubocop to ensure you are complying with the Ruby style guide. Refer to (https://rubocop.readthedocs.io/en/latest/) for cops/violation details.
rubocop -
Commit, with a meaningful & descriptive message - this is very important!
git commit -m "Title for your commit" -m "A little more explanation" -
Push to your fork and open a pull request on Github to the upstream repository.
-
Wait for comments and feedback - we usually get back super fast!
Syntax guidelines:
- No trailing whitespace. Blank lines should not have any space.
my_method(my_arg)ormy_methodand notmy_method( my_arg )a = band nota=b.- Aim for 1.9 hash syntax -
{ dog: "Akira", cat: "Rocky" }rather than{ :dog => "Akira", :pug => "Rocky" } - Follow the conventions you see used in the source already.