Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.84 KB

CONTRIBUTING_CHEATSHEET.md

File metadata and controls

60 lines (39 loc) · 1.84 KB

Contributing to LocalSupport - Cheat Sheet

Be sure to read and understand the CONTRIBUTING.md file first and use this cheat sheet as a quick reference.

Steps for starting a new feature or bug fix

  1. Sync your fork to upstream/develop
git pull upstream develop

Re-syncing daily (even hourly at very active times) on the feature/bugfix branch to ensure that you are always building on top of very latest develop code.

  1. Create feature/bug-fix branche that includes the id of the relevant pivotal tracker ticket, e.g.
git checkout -b 112900047_make_capybara_wait_for_javascript_element

  1. Ensure that each commit in your pull request makes a single coherent change and that the overall pull request only includes commits related to the specific GitHub issue that the pull request is addressing.

  2. Ensure that your pull request description has a hyperlink to the Pivotal Tracker ticket that it corresponds to, to allow anyone to quickly jump to a description of the story, bug or chore that the pull-request is addressing.

  3. Where possible please do add a couple of sentences explaining the approach taken in the pull request.

  4. On the final git commit please include a comment in this format:

Makes Capybara check for virility more robust [Finishes #112900047]

  1. This will close the relevant Pivotal Tracker ticket when the pull-request is merged

  2. Run tests below before making a pull request.

Tests

  1. Run tests
bundle exec rake jasmine
bundle exec rake spec
bundle exec rake cucumber
  1. clean up tests
rake vcr_billy_caches:reset