mirror of https://github.com/status-im/swarms.git
77 lines
3.6 KiB
Markdown
77 lines
3.6 KiB
Markdown
# Meta
|
|
|
|
Please submit a PR with the following template filled in. See README.md for more info.
|
|
|
|
<!-- Please Review https://docs.google.com/document/d/1CaFM2ZXGOKf05_LXMPJeNNy5qJOdAq91EF2Gn2QUBFI/edit# for more details -->
|
|
<!-- in PR the document should be named as`DEV#1-title.md` -->
|
|
|
|
## Preamble
|
|
|
|
Idea: <to be assigned>
|
|
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
|
|
<!-- "If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the Idea. -->
|
|
|
|
## 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. -->
|
|
|
|
<!-- 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 and 1 evaluator/tester -->
|
|
<!-- 'Contributor' should be replaced with a descriptive role type. -->
|
|
- Lead Contributor: <!-- @username -->
|
|
- Testing & Evaluation: <!-- @username -->
|
|
- Contributor: <!-- @username -->
|
|
- Contributor: <!-- @username -->
|
|
- PM: <!--- @username -->
|
|
- UX (if relevant): <!-- @username -->
|
|
<!-- - Contributor: @username -->
|
|
|
|
## Product Overview
|
|
<!-- A short (~200 word) description and motivation of the Idea. Without clear explanation the Idea should not proceed. Can include User Stories -->
|
|
<!-- Testing/Evaluation role accepts responsbility to checkin at Goal dates, -->
|
|
<!-- forces discussion to continue implementation or recommend disband and post-mortem. -->
|
|
|
|
### Product Description
|
|
<!-- What functionality are you adding? What will this look like from a user perspective? Why is this important? -->
|
|
|
|
### Requirements & Dependencies
|
|
<!-- Are there bugs or feature requests in other repositories that are part of this Idea? -->
|
|
<!-- There is no approval unless the idea requires to be reviewed by supporting organelles (Financial, Hiring, or Design). -->
|
|
<!-- The Swarm must develop a fully fleshed out Requirements document for the idea to proceed, to the satisfaction of participants. -->
|
|
|
|
### 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: <!-- Date for evaluation in ISO 8601 (yyyy-mm-dd) format -->
|
|
|
|
Description: <!-- Description of Deliverables-->
|
|
|
|
## Dates
|
|
Goal Date: <!-- Date for evaluation in ISO 8601 (yyyy-mm-dd) format -->
|
|
|
|
Description: <!-- Description of Deliverables-->
|
|
|
|
Testing Days required: <!-- Days required at the end of development for testing -->
|
|
|
|
## 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
|
|
<!-- 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 and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|