Track Your Work

Team members are responsible for tracking and recording their work. This is reflected in two major practices: updating and closing issues, and journalling.

Updating issues

You should update your issues to track the work you have done. Typically this means that you should add details to an issue to clarify the problem, and describe what steps you took to resolve it. This description does not need to be long but should be sufficient to explain what was done. In particular, you should document any impact your issue would have on other design elements. e.g., if your fix invalidated the configuration file, and required that file format to change, you should record that in detail.

If the issue is small, you may only have the opening comments and the closing comments. Add additional content only if it is useful.

When you have resolved an issue, you should

• Close the issue in GitLab, with detailed comments.
• Merge your feature branch back into main, and
• Commit your code changed.

Journaling

Each person on the team needs to maintain a development journal: a wiki page with entries describing what you did in each sprint.

• You should have one section per week e.g., Week 10.
• There should be entries for every time you work on the project. I would expect multiple entries per week.
• Entries should include a date, and a brief description of what you worked on.

A journal is a good practice even in small projects, since you will forget details over the course of project.