Create appropriate standards around TODO

[devinrsmith]

When is it applicable? How should it be done? Should they link to a ticket (just a number, or a url)? If a corresponding TODO issue is closed, should the TODO be deleted? etc.

[mofojed]

TODO's will have the standard TODO format. Link just the ticket number, and the repo name if it's in a different repo. Eg. TODO: #87 Create appropriate standards around TODO Upon merge of PR containing TODOs, a permalink to the TODO in the code is added as a comment on the ticket (could that be automated?). Closing the ticket should address those linked TODOs, and therefore delete those TODO lines.

[mofojed]

The GitHub plugin for VSCode also has "Create Issue Triggers" that allow for quick creation of an issue when typing "TODO", and it automatically adds the issue number in your code, and adds a link to that code in the ticket. An example ticket: deephaven/web-client-ui#45

[devinrsmith]

I'm confused - this is only for VSCode though, yeah? Not for how we should reference GH issues in code?

[mofojed]

VSCode creates the issue in GitHub. If you're not using the plugin and the ticket does not already exist, then create the ticket using the normal New Issue flow, and reference it with the #