Skip to content

Commit

Permalink
Feature/documentation readme update (#44)
Browse files Browse the repository at this point in the history
* update README.md with project overview, mvp description, and guidance for users

* update creating a bounty section in readme
  • Loading branch information
PaulApivat authored Aug 4, 2021
1 parent e7005cb commit cc23da0
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,58 @@ https://www.notion.so/bankless/Bounty-Board-318dc164cc5640cca17e0fb5f484fd90
- [Data Fields](https://docs.google.com/document/d/10jgHxEpkPlArGlsQH1g22utFrAFh2lK-fbXjbq8KkuU/edit)
- [Personas](https://www.notion.so/Bounty-Board-Personas-8e8f2789775a445c82d13c2a9c545185)
- [Bot flowchart](https://media.discordapp.net/attachments/852736763205910538/857786834682511370/image0.jpg?width=978&height=683)

# Project Overview

## Problem

Currently, Bankless DAO bounties are not in a centralized location causing confusion and makes it challenging for members, new and old, to contribute. Also Level 0's do not have intuitive ways to get involved and earn $BANK other than buying in the secondary markets.

## Solution

For the DAO to grow, we need a way to attract, retain and coordinate talent. The bounty board, accessible to members and non-members will connect the DAO to a continually expanding talent pool.

In addition, we need a way to codify meaningful units of work. Given the diversity of jobs to be done in a DAO, the bounty board allows bounty _creators_ to define and specify the scope of tasks along with expected deliverables.

Finally, we need a way to formalize the flow of capital, beyond an informal, organic tipping culture that exists to formally recognize contributors for their knowledge, skills and abilities.

The bounty board will be a key mechanism for coordinating talent, tasks and capital.

## Minimal Viable Product 1.0

### Bounty Card Definition

For the MVP, we are focusing on the bare requirements for a Bounty Card to be created by a user via DEGEN and/or Frontend UI, with the following key fields:

- **season**: In what season is this bounty being created for?
- **Title**: Bounty Titles should be like headlines
- **Description**: Provides space to flesh out the scope, deliverables and timeline for the bounty.
- **Criteria**: When is a task considered "done" or "complete"?
- **Reward**: Bounty creator indicates `currency` (i.e., $BANK) and `amount` (i.e., 10000) to be paid for completing the work.
- **CreatedBy**: Bounty creator provides their `discordHandle` and `discordId` is automatically generated.
- **CreatedAt**: The date in which the bounty is created.
- **DueAt**: The deadline for completing the work.

#### Bounty Card Status

TBD

#### Users

##### Bot Commands

Testing BOT integration with the Bounty Board happens at The BANKLESS Bot Garage discord server, with the Serendipity MK-I Bot.

The following commands are available for Serendipity MK-I:

/bounty create new
/bounty create validate
/bounty claim
/bounty list

##### Creating a Bounty

Note: This process describes Bot interactions in the Bankless Bot Garage. Development and Production environments will be added soon.

1. Within The Bankless Bot Garage, head to #spam-tastic
2. Enter `/` and see a list of Bots pop up, choose `SERENDIPITY MK-I`

0 comments on commit cc23da0

Please sign in to comment.