Group working model - UrbanOS-Examples/TechnicalWorkingGroup GitHub Wiki

General overview

This document is intended to provide details on how we intend to function as a group. This is not intended to be a 100% cover-all of every possible scenario. Instead this is to be treated as a guide and cover the general principals.

Rough outline:

Segment 3

  1. Milestones
  2. Issues
  3. Labels
  4. consolidate issues into Wiki documents

Tracking of work

We are tracking our work a few ways. Each TWG segment ( current is 3 ) will have a list of deliverables. These deliverables should be cast as Milestones within our issues repository.

Each deliverable / milestone will have some set of requirements. These requirements should be broken down into workable units - issues. These issues should have some set of labels assigned to them. The issues, when appropriate ( 99.9% of the time ), should also have their milestone set to the appropriate milestone.

Flow for work

Generally speaking we are tracking each deliverable in 1 or more issues ( it may be necessary to break a larger issue into smaller workable units ). The overall outcome for each deliverable will be a document of some kind. We have chosen as a group to consolidate these documents into our wiki. Additional information on working with the wiki is somewhat out of scope - reference GitHub Wikis for details.

These wiki documents are intended to be a summarization of the discussion held within the context of the issue(s). The role of the primary document writer is to consolidate the information in its raw state ( eg, comments on the issue ) into a distilled format meant for consumption by ourselves and/or the community.

Practically speaking not every part of the discussion in these issues will make it to the final document. We should link to the issue(s) from the start of the document to preserve access to these thoughts / ideas - there may be points missed during the consolidation process.

The discussions can happen in many formats - Slack / chat, video conference, in person etc. The preference should always be to summarize these off-issue discussions as a comment to the issue and / or capturing as part of a wiki document. There should always be a preference for preservation within the issue as this provides details as to when things were discussed. This could also, for instance, relate to check-in meetings and capturing as part of meeting notes posted to the wiki.