From 5e30d7fb746a92b5ded091c7ec0cab96f6a18958 Mon Sep 17 00:00:00 2001 From: Jarrad Hope Date: Thu, 9 Nov 2017 17:34:05 +0700 Subject: [PATCH] initial commit --- .github/ISSUE_TEMPLATE.md | 60 +++++++++++++++++++++++++++++++++++++++ .gitignore | 1 + 2 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..6188cd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,60 @@ + + + +## Preamble + + Idea: + Title: + Status: <Draft | WIP | Closed > + Created: <date created on, in ISO 8601 (yyyy-mm-dd) format> + Requires (*optional): <Idea number(s)> + Replaces (*optional): <Idea number(s)> + + +## Summary +<!-- "If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the Idea. --> + +## Vision +<!-- A short (~200 word) description and motivation of the Idea. Without clear explanation the Idea should not proceed. Can include User Stories --> + +## Swarm Participants +<!-- Each contributor pledges to the idea with their FOCUS value. (hours per week) --> +<!-- Here all roles in swarm are defined and filled, one of the contributors should responsibility of the Idea as Lead. --> + +<!-- Testing/Evaluation support role is also mandatory to check in on specified Goal dates or earlier. --> + +<!-- A swarm requires at minimum 3 contributors and 1 evaluator/tester --> +<!-- 'Contributor' should be replaced with a descruptive role type. --> +- Lead Contributor: <!-- @username --> +- Testing & Evaluation: <!-- @username --> +- Contributor: <!-- @username --> +- Contributor: <!-- @username --> +<!-- - Contributor: @username --> + +## Requirements +<!-- The Swarm must then develop a fully fleshed out Requirements document for the idea to proceed, to the satisfaction of participants. --> +<!-- There is no approval unless the idea requires to be reviewed by supporting organelles (Financial, Hiring or Design). --> + +## Goals & Implementation Plan + +<!-- Testing/Evaluation role accepts responsbility to checkin at Goal dates, --> +<!-- forces discussion to continue implementation or recommend disband and post-mortem. --> + +### Minimum Viable Product +<!-- Mandatory, completes the Idea in the fastest route possible, can be hacky, needed to feel progress --> +Goal Date: <!-- Date for evaluation in ISO 8601 (yyyy-mm-dd) format --> +Description: <!-- Description of Deliverables--> + +### Iteration 1..N +Goal Date: <!-- Date for evaluation in ISO 8601 (yyyy-mm-dd) format --> +Description: <!-- Description of Deliverables--> + +## Supporting Role Communication +<!-- Once Requirements and Goals are fleshed out, then it should be communicated to supporting organelles if required --> + +## Post-Mortem +<!-- Only necessary when in Closed state --> +<!-- Should summarize how the Swarm behaved, document what went well, what didn't --> + +## Copyright +Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4c584b2..e5039f2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ *.* +!.github !.gitignore !*.md \ No newline at end of file