Rules TODO Page
Jesse Jones
http://groups.google.com/group/gendarme/web/rules-todo-comments-enhancements?hl=en
Surely it isn't supposed to collect all of our TODOs. For example, if
I write a new rule and add a TODO describing a potential future
optimization wouldn't that go in the code instead of the page?
It seems to me that the way to go here is to treat the page as a
repository of ideas we may want to pursue and future directions we'd
like to take. In other words a higher level roadmap for anyone who may
want to work on gendarme extracted from our individual ideas and from
TODOs (kept) in the code.
-- Jesse
Sebastien Pouliot
> I don't understand the purpose of
> http://groups.google.com/group/gendarme/web/rules-todo-comments-enhancements?hl=en
>
> Surely it isn't supposed to collect all of our TODOs.
No, it's not. I maintain my own TODO (e.g. tomboy notes), I write TODO
in code... some of them are high-level, some are pretty low level
details, some are more ideas than real TODO, some are, likely, only
wishful thinking ;-)
Still a lot of it should, slowly, migrate to this TODO since it will get
a better visibility there, both for discussions and for anyone who
wishes (more quickly than me) to fix a particular issue.
> For example, if
> I write a new rule and add a TODO describing a potential future
> optimization wouldn't that go in the code instead of the page?
As the author of the rule you have given a kind of ownership on your
rule. That means that everyone expect you to be aware of your own TODO
inside that/those file(s). Even then some of the TODO could be better
if moved (or duplicated) in the document (on a case-by-case basis, I
trust everyone judgment on that).
OTOH this 'author/rule' is a special case. That does not scale well if
all committers* writes TODO/questions everywhere in the source code.
Simply because people won't re-read the rules periodically to see if new
TODO have pop up, nor would it be discussed between the author and the
TODO requester.
* and we need to keep in mind that the number of people with SVN commit
access is quite low compared to the number of subscribers on this list.
The document gives write access to everyone in a single, shared TODO
list.
> It seems to me that the way to go here is to treat the page as a
> repository of ideas we may want to pursue and future directions we'd
> like to take.
Yes. More people, more ideas, less structure and no warranty ;-)
> In other words a higher level roadmap for anyone who may
> want to work on gendarme extracted from our individual ideas and from
> TODOs (kept) in the code.
No, it should not be confused with the roadmap*. A roadmap is generally
a (set of) direction(s) that follow a consensus (or at least someone who
stepped to work on some features).
So this page is more a brainstorming area, where we can keep a
single-view of several, potentially conflictual, ideas. Some of it may
end up into the roadmap, some of it may stay there indefinitely, some
may gets fixed/implemented at anytime (bypassing the roadmap).
Sebastien
* a real roadmap exists (and needs to be updated) but is not, in
general, about rules. http://www.mono-project.com/Gendarme.Roadmap