On 1/30/07, Ole Ersoy <[EMAIL PROTECTED]> wrote:
Hey Emmanuel, <snip/>I noticed there's a note in there about no TODO's in the code.
Yes, we don't have any TODO rule as a matter of fact. Personally I like todo's because some of us might
check code in and have todos in there. Once we have better repository capabilities we can feed those into a "Help Wanted" work queue, and make it available via the "Help Wanted" section of the site.
Well, I'm balanced (but this is just me, may be). We have currently 75 TODOs in the 1.0.1 code base. IMHO, TODO is a great idea butit has some drawbacks. Pros : - You can quickly add some comment in your code if you feel like you have some more thing to do - Eclipse/Idea now have tools that help you to deal with TODOs - At least, it's better then a piece of paper : closest to where the problem is. Cons : - It clutter the code. - If the TODO is important, then why do we have to put it in code, when we already have JIRA which is good also to manage the roadmap? - If we have smething TODO, isn't it better TODO it instead of postponing the work? - last, not least, TODO don't generally capture all of your intention, and does not allow other users to discuss the point. If you add a TODO in your code, that mean you either didn't had time to finish (but this is not a vaild excuse IMHO), or that you don't have a clear vision on how to implement something (and then it deserve a discussion either on the ML or in a JIRA) I guess that it is something we should agree on before setting rules about TODOs. My best guest is that you should use it whith caution, if needed. If a vote is launched about "allowing commiters to use TODOs", I'm sorry to say that I will vote it -1, for the reasons I listed in cons... So better not launch th vote, and let it be the way it is currently :) Note that I don't want to be harsh with you, and reject a -- Cordialement, Emmanuel Lécharny www.iktek.com
