Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.1 KB

Contributing

Fork, then clone the repo:

git clone [email protected]:your-username/grape_token_auth.git

Set up your machine:

./bin/setup

Make sure the tests pass:

./bin/rspec

Make your changes and add tests for your change. I use rubocop with the default style guide for consistency.

Make sure the tests pass before committing:

./bin/rspec

##Git committing

I prefer short, atomic commits. Obviously, this isn't a deal breaker but I believe it makes for a better repo. When writing git messages, refer to this great post by Tim Pope. As a small addendum, I try to begin each message with one of the following words:

  • Add
  • Modify
  • Re-factor
  • Fix
  • Remove
  • Tidy
  • Update

I find this expresses the intent of the commit and also helps keep things atomic. I picked this trick up from this post.

Push to your fork and submit a pull request.