Skip to content

Wiki and Issues

J.L Stevens edited this page Jul 21, 2014 · 11 revisions

This page provides instructions for how we want to use this Wiki and GitHub Issues.

Current Situation

We've discussed our (five!) existing methods for keeping track of things to do for IOAM projects:

  1. Issues filed at GitHub (a mix of feature requests, ideas, bugs, and user errors)

  2. Old sf.net issues converted to GitHub issues (also a mix)

  3. Topographica.org's manual list of big Future Work. tasks (mostly outdated).

    JL Suggestion: This page is very generic/general. Can't it be renamed to 'Contribute' and left alone as it is mostly suggesting how people could contribute to Topographica? In other words, this page isn't really a TODO list/wishlist for existing developers!

  4. Topographica.org's manual list of detailed Current tasks (mostly outdated),

  5. Items mentioned on project wikis e.g. Topographica's wiki

Obviously, that's a mess, and is only for historial reasons, not because anyone ever thought this was a good way to do things.

Plan for this Wiki and GitHub Issues

To restore sanity, we decided to keep only 1 and 5, with everything sorted as:

  1. Open GitHub issues should be restricted to actual, specific problems that potentially have solutions.
  2. We should try to eliminate the remaining old sf.net issues, either closing them if no longer relevant, or adding information (typically from Chris's email) when the existing information is too terse to evaluate).
  3. Most of the Future Work data should move to a suitable section of the wiki, sketching out our future plans for IOAM projects. (Not sure if this should be IOAM's wiki or Topographica's.)
  4. Most of the "current" tasks should be eliminated, with the rest either promoted to GitHub issues or items on the wiki
  5. The wiki should include a section for future work items, described not by technical solutions (e.g. "investigate hdf5pickle") but by the problem we need to solve "define an archival snapshot saving format", and only then discussing solutions.

If anyone has any objections or suggestions for this plan, let me know. Otherwise, let's all try to gradually implement it.