development_workflow.md

Development Workflow

A. Choose an issue to work on

1. Choose an issue from the Ready column (or, if needed, create an issue)
   • https://github.com/orgs/opendifferentialprivacy/projects/1
2. Add yourself as the Assignee
3. Move the issue to the Ready Column
   • Note the issue number, e.g. issue 3

B. Create a new branch from the develop branch

1. Name the new branch starting with the issue number and description of your choice
   • e.g. "3_" + "resize" ->
     • 3_resize

C. Switch your development machine to the new branch

• e.g. git checkout 3_resize

D. Upate your branch with any changes on develop

1. Check in your changes to the new branch, 3_resize
2. Checkout the develop branch and retrieve any changes

   git checkout develop
   git pull
   

3. Switch back to your "issue" branch (3_resize)

   # git checkout [issue branch]
   git checkout 3_resize
   

4. Merge and fix any conflicts

   git merge origin develop
   

E. Ready for Review

1. If needed, merge with develop (repeat step D)
2. Check that you've written/updated any needed tests
3. Make a pull request
4. Have a team member review the pull request
5. Merge the pull request!