Talk:Todo

From PostgreSQL wiki

Jump to: navigation, search

Contents

Todo list administration

The following is an explanation of the layout of the Todo list, and guidance on how to take care of some of the more common administrative tasks.


Structure

Todo items are grouped into sections, and can optionally be further grouped into subsections.

A section is marked up using a second-level heading:

== Section name ==

A subsection is marked up using a third-level heading, and we use the templates Template:TodoSubsection and Template:TodoEndSubsection to indent the items in the subsection:

=== Subsection name ===
{{TodoSubsection}}

items ...

{{TodoEndSubsection}}

Every call to {{TodoSubsection}} must be followed by a corresponding {{TodoEndSubsection}}.

Note that, as with most mediawiki pages, each section and subsection has a link which allows you to edit that part of the list in isolation. This is shown as a link labelled "[edit]" to the right of the corresponding heading. This is the preferred way to make localised changes to the list. Not only does it make for easier and quicker editing, but it minimises the risks of accidental changes and conflicts with other users.


Adding items

Items can be added using one of the following three templates:

  • Incomplete item - {{TodoItem}} for ordinary pending items.
  • [E] Incomplete item - {{TodoItemEasy}} for pending items which can be considered relatively easy to implement, and therefore may be appropriate for less experienced hackers.
  • [D] Completed item - {{TodoItemDone}} for items which have been completed and committed to version control, and expected to be released in the next Postgres version.

In each case, the syntax is the same. The templates take two parameters: the first is the item title, and the second is an optional item description.

{{TodoItem|title[|description]}}

If the item's title or description contains an equals sign (=), you must explictly number the parameters to avoid confusing the parser:

{{TodoItem|1=title[|2=description]}}


Adding commentary/links to items

The item description can contain multiple paragraphs and all the usual wiki formatting. If you need to add a brief comment (perhaps to summarise discussions on the topic, or to explain what the feature entails), just add it to the description as you would any other wiki content.

To add a link to a discussion, you can simply add a URL to the relevant thread in the mailing list archives. If you know the Message-ID, you can always use Template:MessageLink.


Marking items as easy

Change the name of the item template from TodoItem to TodoItemEasy. If it turns out not to have been easy after all, you can simply do the reverse to make it an ordinary item again.


Marking items complete

Change the name of the item template from TodoItem or TodoItemEasy to TodoItemDone.


Removing items

Typically when Postgres releases a new version, we'll want to clean out all the old "done" items. Other candidates for removal from the list might include accidental duplicates, or items that just plain aren't interesting to the project. In any case, the procedure for removing an item is to simply delete the whole template call.

This must be the most serious and extensive to-do list I have ever seen

It makes me quite comfortable, knowing issues aren’t swept under the rug but are set to be fixed as soon as resources allow.

Personal tools