-
-
Notifications
You must be signed in to change notification settings - Fork 25.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
TODO/FIXME comments in the code #8581
Comments
Kudos for taking the time to open such a detailed issue! This shows a lot of motivation from your part.
Basically this seems like a lot of tedious work for very little benefit. I am going to close this one. Feel free to reopen/shout if you strongly disagree. |
I don't think it would hurt for someone to take a look at these, but I'm
not sure each deserves an issue at this point. Some are likely to be stale
and can be removed easily, others are likely to need fixing. Some may
already have issues. But I'd expect that if the code deserved that kind of
remark, few of these would be "easy" issues, and we're lacking in expert
time to handle more complex issues so it's not worth littering the issue
tracker with them.
…On 14 Mar 2017 8:45 pm, "Loïc Estève" ***@***.***> wrote:
Kudos for taking the time to open such a detailed issue! This shows a lot
of motivation from your part.
I think your time and energy will be better used for the project if you
try to tackle existing issues, e.g. the ones with a "bug" label.
If you agree that this would be useful to do
Basically this seems like a lot of tedious work for very little benefit. I
am going to close this one. Feel free to reopen/shout if you strongly
disagree.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#8581 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAEz6_f1mVIlaDiu-JONEaPdnD_qRXt1ks5rlmHTgaJpZM4Mbd-9>
.
|
Description
For a university course I did an analysis of TODO/FIXME comments currently present in the Scikit-learn repository. I looked at the files in which the comments were and at the age of the comments. This gives 76 TODO comments in 48 files and 20 FIXME comments in 16 files:
The comments have an average age of 1390 days. With one striking example being a "FIX ME SOON!" comment added on Jan 3, 2013 (30045e161b88ada96f8d9aeb04e61). Which is still present in the current code (but in a different file). This shows that this might not be the best way to track these issues (and since there aren't many recent TODO/FIXME comments it seems like a practice that is no longer that acceptable in Scikit-learn). To avoid technical debt which contributors might not be aware of, it seems to me that it would be better to have these among the issues on GitHub to keep everything in a central location. Therefore I propose the following workflow:
If you agree that this would be useful to do and also agree on the steps to solve it then this is something I would like to work on.
The text was updated successfully, but these errors were encountered: