GROUP Activity: Docstrings and tests
In this activity you will apply some of the previous lessons to your own software project.
As a group:
- Identify at last one function, class, or module which is missing a docstring or has an incomplete docstring.
- For each of the above items decide within your group what the desired functionality.
- One person should submit an issue on GitHub to identify the item with missing or incomplete docstring, and include a description of the desired behaviour.
- Assign two people to the issue: one to update the docstring, and one to create a set of tests that will test for the desired behaviour.
- Have the two people work on the same issue branch.
- Once the documentation and testing is complete create a pull request and assign at least one person to review the request.
- When all tests pass, and the reviewer is satisfied with the pull request, accept it and merge the branch back into either your main or development branch, depending on the branching workflow for your project.
- Repeat the above with additional items until each member of your group has had a chance to participate in the ticketing, documentation, testing, and reviewing. (You may need only 1-2 iterations if you have small team).
The task above will require some coordination as to who is doing what and when. Remember what you learned from your project management and communication lesson. This could be an opportunity to use a Kanban board to organise your team.