Add special designation for issues linked in code comments
Problem to solve
Developers are increasingly making sparser code comments, but one big use-case is for TODO comments. In this pattern developers might use:
//TODO: Update docs for merge trains
But it would be more SSOT to write
//TODO: !29771 (merged)
Right now there is no great way to build a single source of "code commented" issues that would be easier for developers to pick up and complete since they know exactly where in the code the issue should be added.
Intended users
App Developers: App developers could more easily keep track of where they are leaving additional todo work in code being able to quickly return to the context that the todo was added.
Community Contributors: Community contributors interested in contributing to projects could find issues that would be good initial contributions.
Engineering Managers: Engineering managers who wanted to assign on-boarding tasks could find issues associated with code comments as potential "low hanging fruit."
Further details
Use Case - Add a comment
- As an application developer, in order to keep my comments single source of truth, I should be able to create and reference a follow-up MR or issue directly in the code where I know it should reside.
Use Case - Find comment issues
- As a community contributor or engineering manager I should be able to quickly reference a set of issues or MRs that are marked as TODO in my project's code.
Proposal
Parse project code for the TODO: ! and TODO: # regular expressions and tag them with a ~Code-Comment label.