GROUP Activity: Working on the same problem

In this activity you will practice working in a team as you go through a simple development cycle.

1. As a group, identify a minor issue with your current project. (Don’t feel bad, the only projects that don’t have issues are the ones that no one is using).
   • Since the focus here is on the life-cycle of a bug, choose a small thing that is easy to identify and fix.
   • A function without a docstring would be ideal (and probably easy to find).
2. Have one team member create an issue that describes the problem and explains what a solution would look like.
   • eg “myFunc(4) should return a filename”, or “myFunc should have a docstring in <format>”.
3. Create a new branch for development work called <Feature> or Issue<number>.
4. Assign at least two team members to work on this issue.
5. Have one team member create a solution for the issue and then:
   1. Push the changes to the remote repository,
   2. Open a pull request to merge this branch into main,
   3. Set the assignees to be all the members working on the issue,
   4. Set the reviewer to be a team member who is not working on the code (if you have enough people, otherwise choose someone other than the pull request creator), and
   5. Add whatever labels look appropriate.
6. Have the other team members:
   1. View the changes via the “files changed” tab of the pull request,
   2. Comment on what is good and what needs improving,
   3. Pull the active branch to their local machine,
   4. Make an improvement and commit the change, and
   5. Push the change back to the active branch.
7. Everyone should have an opportunity to make comments and changes, but you’ll need to coordinate who is doing what and when to minimise the number of merge conflicts that occur.
8. Once everyone has had a chance to view/comment/change, have the reviewer sign off on the pull request and merge the changes into the main branch.