Development Workflow - YaleSTC/reservations GitHub Wiki

Starting work

  1. Make sure GitHub issue exists
  2. Create issue branch
  • naming convention: [ISSUE NUMBER]_[ABBREVIATED NAME] (e.g. 528_short_term_cart_fix)
  • to create remote branch with tracking run the following: git push origin master:refs/heads/1234_branch_name
  1. get coding :-)

While working

  • Write RSpec tests for significant functionality (see TDD LINK HERE)
  • Update factories if necessary
  • Commit often, write short but descriptive commit messages
  • Update the GitHub issue with longer comments

Pull Request

  1. Ensure all tests pass
  2. Ensure your changes didn't break untested behavior (i.e. seed script in db/seeds.rb)
  3. [TODO] check code quality (e.g. Rubocop)
  4. Update Changelog (see Changelog Guidelines)
  5. Issue pull request
  • while possible, convert issue to pull request using Hub