33 lines
2.0 KiB
Markdown
Raw Normal View History

2017-01-13 21:01:36 +07:00
# Commiteth
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
Commiteth aims to incentivise development on open source projects hosted on Github.
2017-01-12 17:15:40 +07:00
2017-01-14 14:30:03 +07:00
[commiteth.com](http://commiteth.com)
2017-01-14 14:28:19 +07:00
[github.com/status-im/commiteth](https://github.com/status-im/commiteth)
2017-01-13 18:17:43 +07:00
2017-01-13 21:01:36 +07:00
## How does it work?
2017-01-13 18:17:43 +07:00
2017-01-13 21:01:36 +07:00
Commiteth fosters open source development by incentivising pull request submissions by attaching a ETH or ERC20 cryptotoken bounty to open issues.
2017-01-13 18:17:43 +07:00
2017-01-13 21:01:36 +07:00
A project maintainer must first add their project to Commiteth, and include their address (this address & Commiteth's address will be the two signatories on the multisig wallet).
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
Once done, Commiteth will list the project and crawl it's Github Issues with the label `bounty`. When found Commiteth will deploy a Multisig wallet to the network with itself and project maintainer as signatories.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
Commiteth will then generate an image containing the address, a QR code of the address and the balance of the wallet and comment on the issue. (as well as this information in plaintext). Commiteth will update this comment with a new image everytime the balance has changed and when the bounty is complete.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
[![An example bounty image](img/commitethbounty2.png)]( "An example bounty image")
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
Commiteth observes the repository for pull requests that contain a reference to the `bounty` issue by the use of the Github special "`fixes #6`" feature. Read more about [Closing Issues via Pull Requests here](https://github.com/blog/1506-closing-issues-via-pull-requests).
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
When this pull requests are accepted and merged, Commiteth will sign a transaction in the associated wallet and display it to the maintainer as a pending transaction to sign.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
The maintainer must load commiteth.com in Mist or Metamask to complete the transaction.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
## How do I use it?
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
First you must sign-in to Commiteth via a Github login. Then you must submit your receiving address.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
Once done you are ready to submit pull requests for issues with the `bounty` tag.
2017-01-12 17:15:40 +07:00
2017-01-13 21:01:36 +07:00
If your pull request is accepted, Commiteth will sign the bounty balance to you, however you must wait until the maintainer confirms the transaction.
2017-01-12 17:15:40 +07:00