Overview

Create multiple TODOs referencing the same issue.

It is quite common to have multiple TODOs in a project referencing the same ticket. This allows developers to highlight related chunks of code and create a sort of task list, with each TODO acting as an anchor.

Catana includes a feature to improve this workflow and help resolve related TODOs.

Reference

Any TODO with a title that includes the keyword Ref #123 (Where 123 is the number of a opened issue in your GitHub tracker) would be grouped together with other TODOs with the same reference.

The first time a ticket is referenced in a TODO, Catana creates a comment on the referenced issue, indicating the line and file that require attention. As more TODOs referencing the same ticket are added, Catana updates the previously created comment and the task list.

When a TODO that was part of a group is removed from the codebase, Catana reflects this and updates the task list.

Finally, when all TODOs have been removed, Catana considers the ticket solved and will inform your team by commenting on the ticket.

Any time a TODO that is part of a group changes location (line or file), Catana reflects the change.

The task list will always remain up to date, eliminating the need to search through the git history.

Dashboard

When viewing a TODO item on the Catana dashboard, a list of related TODOs is displayed.