Mudlet
Move TODO comments into issues
Brief summary of issue:
Code has comments like TODO scattered accross different files. They stay untouched for years.
Reasons for adding this feature:
I can only imagine it being easier to write the comment in code while coding there, that's why it was done. But these issues are hard to keep track of. History shows, they mostly stay unsolved forever. It also gives a bad impression for new developers diving into code to find these there.
Expected result of feature:
Delete all such comments in source, and move then into separate issues here on github, where they can be scanned easily and discussed in more detail, solutions can be pondered, etc. Until somebody actually does it, or we decide it does not need to be done after all.
Ideas for how to solve / implement:
Search source code for all relevant keywords. Which can you think of? Please comment below!
- TODO
- FIXME
- ...?
As I commented in Discord, they can be (and for the PLACEHOLDER comment, are being) usefully used with the Qt Creator TODO plugin.
:thinking: Of course if someone wants to go through and find all of them (or at least the TODO and FIXME ones) and create issues for them - and perhaps cross-reference the issue number in a revised comment (just add ISSUE #1234 or {#1234} perhaps) as a PR to close this issue...
When is the last time you received input based off of a TODO comment in source? @SlySven
Yes, the idea is to close this issue after creating issues for all the TODO and FIXME comments.
I am fine with leaving PLACEHOLDER in place, as that seems to ease jumping through code with Creator, which I hardly ever use.
Could you please paste the list of other keywords from source you showed in Discord here as well?
Could you please paste the list of other keywords from source you showed in Discord here as well?
Found the list. It says: SAVE, TODO, NOTE, FIXME, BUG, WARNING, PLACEMARKER
@SlySven:
:thinking: Of course if someone wants to go through and find all of them (or at least the
TODOandFIXMEones) and create issues for them - and perhaps cross-reference the issue number in a revised comment (just addISSUE #1234or{#1234}perhaps) as a PR to close this issue...
... then you would support this course?
Then, to make that matter not harder than needed, if we now all agree on that course forward making most sense, we could probably start today by not adding any new TODO items as comments like before, but instead add an issue in Github and link to it from comment. OK?
I would prefer the syntax ISSUE #1234 you suggested.
OK? @vadi2 @keneanung
At the risk of blowing out an already large issue list, I can locate and start adding these TODO's as github issues.
Is this still a concern? Would this be helpful to the devs?
Today #7131 deletes a few TODO-comments as requested by Danger checks while moving other code around.
This spawned a bit of discussion in chat at https://discord.com/channels/283581582550237184/283582439002210305/1206298541316898816 pondering the merit of these hints-for-improvement, both as TODO-comments and Github-issues, while in effect none got much traction during recent years.