[Zope3-dev] When to use XXX

[Jim Fulton]

1. You are working on a development branch.  You are up
    against a deadline and you need to incur technical debt.  You
    use XXX to identify things that need to be done differently or
    more carefully or to note things that need to be tested.
    You *will* get rid of the XXXs before checking in to the trunk
    or a release branch.

2. You are working on a development branch.  You are prototyping to
    to understand a problem. You use XXX to identify things that need
    to be done differently or more carefully or to note things that
    need to be tested. You *will* get rid of the XXXs before checking
    in to the trunk or a release branch, however, you will often be better
    off starting over doing things the right way based on what you learned.

3. You are reading the code and uncover a serious problem that needs to be
    fixed. You should submit a collector issue that describes the problem.
    You *may* add an XXX comment to the code to leave a clue for code readers.
    This XXX comment must most include a reference to the collector issue,
    including the collector number.

 From now on, if you check an XXX into the trunk or a release branch,
you must first, make a collector entry that describes the issue.
If you know who is responsible, assign it them.  Reference the collector
entry in the XXX.

Jim

-- 
Jim Fulton           mailto:jim at zope.com       Python Powered!
CTO                  (540) 361-1714            http://www.python.org
Zope Corporation     http://www.zope.com       http://www.zope.org