Iris Git workflow

Note: this page partially obsolete and a better example lives here.

---

All work in Iris is tracked in Github issues. When you have been assigned an issue, do the following.

• Get the latest "dev" branch

  • git checkout dev

    git pull origin dev

• Create branch from "dev" and name it for the issue you are working on

  • Best to leave off your name, slashes, pound signs, etc.

  • If you must work on multiple issues in the same branch, name the branch as such

  • Examples:

    git checkout -b issue75

    git checkout -b issue100_101_102

• Do your work
  • Please include only the work from these issue(s)
• When you are finished, go to the Github site and create the branch there
  • Make sure you create it from "dev" in drop down menu
• Push your work to the remote branch
  • git push origin issue75
• Send message that it is ready for review
• After code has been approved, you will get a message on the Github issue that it is ready for a PR
  • Do not create a PR until you get this approval
• Create a PR against the "dev" branch
  • In the PR note, include the text "Closes #XXX" where "XXX" is the issue number
  • If you accidentally create a PR against "master" or another branch, delete PR and start over
• Wait for sheriff to land the PR, or - if there are merge issues - follow the sheriff's instructions
• Do not delete branch on the Github site. We will delete old branches weekly.
• Do not close issue. It will be closed either a) automatically when it is merged to master, or b) on Fridays when we do an issue triage