Skip to content

Latest commit

 

History

History
93 lines (60 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

93 lines (60 loc) · 3.63 KB
Raw

Contributing

We love pull requests from everyone.

Here's a quick guide for contributing:

  1. Fork the repo.

  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: bundle && bundle exec rake

  3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!

  4. Make the test pass.

  5. Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on, if not accept, pull requests within a week's time. We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:

  • Use Rails idioms and helpers
  • Include tests that fail without your code, and pass with it
  • Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution

Before We Can Merge

If you've had a pull request reviewed and accepted, congratulations! Before we can merge your changes, we'll need you to rebase off origin/develop and squash your commits into one. This will give us a cleaner git history.

Never done this before? No problem. We'll walk you through it, and you can read a deeper guide about rewriting history to understand more.

On your command line you'll want to do:

git rebase -i origin/develop

This says to rebase your work off of develop. If you use an editor like Sublime Text, you'll want to be sure your editor doesn't close without a response.

From here, you'll see something like:

pick f48d47c The first commit I did
pick fd4e046 The second commit I did

You'll want to change everything after your first commit from pick to squash. This tells git you want to squash these commits into the first one.

From here, you'll get an editor that will let you change the commit messages.

# This is a combination of 2 commits.
# The first commit's message is:
The first commit I did

# This is the 2nd commit message:

The second commit I did

You'll want to remove or comment out everything except for the first message, which you can edit to be a more complete summary of your changes.

To finish, you'll force push this new commit with the following command:

git push origin [my-feature-branch] --force-with-lease

The --force-with-lease flag will refuse to update a branch if someone else has updated it upstream, making your force push a little safer.

Running Tests

We use RSpec for unit tests. If you submit tests that are not written for RSpec without a very good reason, you will be asked to rewrite them before we'll accept.

Testing helpers

We've written some convenience helpers to help with API testing. The helpers are found in spec/support/helpers as:

  • ApiHelpers
    • authenticate which is an authentication helper that uses OAuth2 to authenticate requests and return a token used to make future requests.
  • RequestHelpers
    • json which returns the JSON of the last response as a Ruby object
    • authenticated_get(path, args, token) (and _post, _put, _delete) which takes the URL path, any arguments, and the token generated by the authenticate method above. You can grep for good examples of these in action.

These helpers are included in specs by default via the rails_helper. You can just call these methods directly.