mirror of https://github.com/status-im/swarms.git
Update template
This commit is contained in:
Oskar Thoren
Oskar Thorén
parent
e4dddbdc90
commit
fe77cb4dc9
146
TEMPLATE.md
146
TEMPLATE.md
|
|
@ -1,134 +1,58 @@
|
||||||
---
|
---
|
||||||
id: 000-template
|
id: #000-template
|
||||||
title: Swarm Template
|
title: Swarm Proposal
|
||||||
status: draft
|
status: research/specification/implementation/maintenance
|
||||||
created: YYYY-MM-DD
|
lead-contributor:
|
||||||
category: core
|
|
||||||
lead-contributor:
|
|
||||||
contributors:
|
contributors:
|
||||||
-
|
-
|
||||||
-
|
-
|
||||||
-
|
budget:
|
||||||
exit-criteria: no
|
- actual: xxx
|
||||||
success-metrics: no
|
- estimate: yyy
|
||||||
clear-roles: no
|
- currency: ETH/USD/SNT
|
||||||
future-iteration: no
|
|
||||||
roles-needed:
|
|
||||||
- QA
|
|
||||||
- PM
|
|
||||||
- UXR
|
|
||||||
- Clojure dev
|
|
||||||
- Go dev
|
|
||||||
- Contracts dev
|
|
||||||
- Designer
|
|
||||||
- Community
|
|
||||||
okrs:
|
|
||||||
-
|
|
||||||
-
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Preamble
|
# Swarm proposal
|
||||||
|
|
||||||
Idea: <to be assigned>
|
## Summary and Goal(s)
|
||||||
Title: <title>
|
|
||||||
Status: <Draft | In Progress | Closed >
|
|
||||||
Created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
|
|
||||||
Requires (*optional): <Idea number(s)>
|
|
||||||
Replaces (*optional): <Idea number(s)>
|
|
||||||
|
|
||||||
## Summary
|
## Communication
|
||||||
|
(required)
|
||||||
|
`status channel (same as swarm id)`: [#000-foobar](https://get.status.im/chat/public/000-foobar)
|
||||||
|
`sync frequency`: Weekly Sync
|
||||||
|
|
||||||
> "If you can't explain it simply, you don't understand it well enough." Provide
|
## Research
|
||||||
> a simplified and layman-accessible explanation of the Idea.
|
(required)
|
||||||
|
`timebox research (approx)`
|
||||||
|
|
||||||
## Swarm Participants
|
(optional)
|
||||||
|
`eips`, `competitors`, `existing research`, `wireframes`, `spike (PoC)`
|
||||||
|
|
||||||
> Here all roles in swarm are defined and filled, one of the contributors should
|
## Specification
|
||||||
> responsibility of the Idea as Lead.
|
|
||||||
>
|
|
||||||
> Lead Contributor is the Owner of the Idea. If required, they can get support
|
|
||||||
> from a PM, but should be responsible for end to end execution of the Idea.
|
|
||||||
> This includes ensuring appropriate resources are allocated, setting realistic
|
|
||||||
> timelines and milestones, and any post-launch metrics or bug fixes that are
|
|
||||||
> attributed to the Idea
|
|
||||||
>
|
|
||||||
> A swarm requires at minimum 3 contributors. For user-facing swarms
|
|
||||||
> PM/UX(R)/Eng functions have to be present.
|
|
||||||
>
|
|
||||||
> For swarms lead by core contributors, swarm lead is evaluator by default.
|
|
||||||
>
|
|
||||||
> 'Contributor' should be replaced with a descriptive role type.
|
|
||||||
|
|
||||||
- Lead Contributor:
|
> do after `Research`
|
||||||
- Evaluator (defaults to lead contributor):
|
|
||||||
- Contributor:
|
|
||||||
- Contributor:
|
|
||||||
- QA:
|
|
||||||
- PM (required for user-facing):
|
|
||||||
- UX(R) (required for user-facing swarms):
|
|
||||||
|
|
||||||
## Product Overview
|
(required)
|
||||||
|
`timelines (approx)`
|
||||||
|
|
||||||
> A short (~200 word) description and motivation of the Idea. Without clear
|
(optional)
|
||||||
> explanation the Idea should not proceed.
|
`user stories`, `architecture`, `designs`, `PoC`
|
||||||
|
|
||||||
### User Stories
|
## Implementation
|
||||||
|
> do after `Specification`
|
||||||
|
|
||||||
> What user stories are you solving?
|
> All swarm contributors should test and break the implementation, especially developers
|
||||||
|
|
||||||
### Requirements & Dependencies
|
(required)
|
||||||
|
`document progress`
|
||||||
|
|
||||||
> Are there bugs or feature requests in other repositories that are part of this
|
(optional)
|
||||||
> Idea?
|
`townhall demo`
|
||||||
|
|
||||||
### Security and Privacy Implications
|
## Maintenance
|
||||||
|
|
||||||
> If the security and privacy implications of the idea are non-trivial,
|
`lead-contributor`,`post-mortems`
|
||||||
> elaborate on the problem space and a plan for resolving it here.
|
|
||||||
|
|
||||||
## Dates
|
|
||||||
|
|
||||||
> Description of deliverables at a given date, for example each Town Hall (default).
|
|
||||||
> Add more iterations as required.
|
|
||||||
>
|
|
||||||
> Evaluator accepts responsbility to checkin at Goal dates, forces discussion to
|
|
||||||
> continue implementation or recommend disband and post-mortem.
|
|
||||||
>
|
|
||||||
> Upcoming Town Halls this quarter:
|
|
||||||
> 2018-04-23, 2018-05-07, 2018-05-21, 2018-06-04, 2018-06-18
|
|
||||||
|
|
||||||
### Minimum Viable Product
|
|
||||||
|
|
||||||
> Mandatory, completes the Idea in the fastest route possible, can be hacky,
|
|
||||||
> needed to feel progress. See https://imgur.com/a/HVlw3
|
|
||||||
|
|
||||||
Goal Date:
|
|
||||||
|
|
||||||
Description:
|
|
||||||
|
|
||||||
### Iteration 1
|
|
||||||
|
|
||||||
Goal Date:
|
|
||||||
|
|
||||||
Description:
|
|
||||||
|
|
||||||
## Success Metrics
|
|
||||||
|
|
||||||
> Assuming the idea ships, what would success look like? What are the most
|
|
||||||
> important metrics that you would move?
|
|
||||||
>
|
|
||||||
> Example: Onboarding conversion rate. Target >30% full funnel
|
|
||||||
|
|
||||||
## Exit criteria
|
|
||||||
|
|
||||||
> Example: Launch new onboarding UI flow
|
|
||||||
|
|
||||||
## Supporting Role Communication
|
|
||||||
|
|
||||||
> Once Requirements and Goals are fleshed out, then it should be communicated to
|
|
||||||
> supporting organelles if required
|
|
||||||
|
|
||||||
## Copyright
|
## Copyright
|
||||||
|
|
||||||
Copyright and related rights waived
|
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||||
via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue