This repository has been archived by the owner on Jun 17, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #501 from dckc/welcome-refactor
refactor README and CONTRIBUTING w.r.t. "Welcome to the Bounty Program"
- Loading branch information
Showing
2 changed files
with
111 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,43 @@ | ||
| # How to contribute | ||
| # RChain Distributed Budgeting and Rewards Bounty Program | ||
|
|
||
| *New here? Before you go any further, read this: [Welcome to the Bounty Program](https://github.com/rchain/bounties/wiki/Welcome-to-the-Bounty-Program).* | ||
| In Aug 2017, the [RChain Cooperative](https://rchain.coop) president, | ||
| [Greg Meredith][lgm], dedicated funds to a distributed budget and | ||
| reward system for working together. | ||
|
|
||
| We're really glad you're here, because we need active contributing members to help this project come to fruition. We've established a community process for contributors to earn RHOC working for the coop, and everyone is welcome to participate. Contributing doesn’t just mean coding; there are many different ways for you to get involved, including community activism, marketing, business development, design, and governance. | ||
| _[README][] is a more general overview; these are the specifics of the | ||
| process._ | ||
|
|
||
| ### Communication | ||
| [LGM]: https://github.com/rchain/bounties/wiki/Greg-Meredith | ||
| [README]: https://github.com/rchain/Members/blob/master/README.md | ||
|
|
||
| [RChain](https://rchain.coop) has multiple channels to make easy communication possible within the growing community. There is a full list of comm channels in the [FAQ](https://github.com/rchain/reference/blob/master/faq.md) but these are the collaborative channels: | ||
| - We work together and keep each other updated through [Github/RChain/bounties](https://github.com/rchain/bounties). | ||
| - We're experimenting with [Mattermost](https://rchain.divvydao.net/community/channels/town-square) and [Gitter](https://gitter.im/rchain/Rholang) to create insight in who does what when and why. | ||
| - The Telegram [RChain Coop](https://t.me/rchain_coop) chat group is for chat, while the [RChain Coop Official Announcements](https://t.me/rchain_official) channel carries official announcements. For Chinese speakers there is a [RChain_Official_Chat_CN](https://t.me/RChain_Official_Chat_CN) group. There is also a QQ group for RChain: 530718666. | ||
| - We've moved from [Slack](https://ourchain.slack.com/messages?) to a [Discord](https://discord.gg/fvY8qhx) server. Discord has several channels to discuss about all kind of things (to join see [Becoming a Member](#becoming-a-member) below). The goal is to create actionable issues in [Github/bounties](https://github.com/rchain/bounties/) that are handled by the community. | ||
| - The different environments are bridged together. So you would see messages from for example Discord in Mattermost, Telegram, or Gitter. | ||
| - We use [Google Groups](https://groups.google.com/forum/#!forum/rchain) for interaction through email and getting access to the RChain Google drive and documents. | ||
| - There are weekly conference calls with unedited archives on [Youtube](https://www.youtube.com/channel/UCSS3jCffMiz574_q64Ukj_w). | ||
| - There is a weekly [Member zoom meeting](https://zoom.us/s/197490909) on Wednesdays, 06:00 PM UTC (Amsterdam +1, New York -5, Seattle -8, Beijing +8), where we discuss the issues that need to be worked upon. | ||
| - And of course our [website](https://rchain.coop). | ||
| The process evolves with experience; stay tuned to | ||
| [bounty-contract](https://github.com/rchain/bounties/labels/bounty-contract) | ||
| issues. | ||
| <!-- 2. [ ] This is the #bounties channel in Discord: | ||
|  --> | ||
|
|
||
| ### Collaboration | ||
| Ops (@lapin7, HJ) explains it in the video | ||
| [RChain, Decentralized budgeting and spending](https://www.youtube.com/watch?v=m6xiTWbEdpA) | ||
|
|
||
| Coop membership is required for some parts of the process, but through [Github/bounties](https://github.com/rchain/bounties/) anyone may create an issue. It's up to us to handle all those issues in an organized manner, based on self organization and decentralization. We trust in skills and common sense to solve the issues and get rewarded in a reasonable way in RHOC. | ||
| [Membership in the RChain Cooperative](#becoming-a-member) is required | ||
| for later parts of the process, but to create an issue, all you need | ||
| is a [GitHub account](https://github.com/join) so that you can create | ||
| or collaborate on work items represented by | ||
| [rchain/bounties github issues](https://github.com/rchain/bounties/issues/). | ||
|
|
||
| The process evolves with experience; stay tuned to [bounty-contract](https://github.com/rchain/bounties/labels/bounty-contract) issues. | ||
|
|
||
| - Work items are represented by [issues](https://github.com/rchain/bounties/issues/). | ||
| - To make one or join work on one, you need to: | ||
|
|
||
| 1. [ ] get/have a [Github account](https://github.com/rchain/bounties) | ||
| 2. [ ] request a Github collaborator role from @lapin7 in one of the comm channels, or mail [[email protected]]([email protected]), to get an invite | ||
| 3. [ ] then confirm the [collaboration invite](https://github.com/rchain/bounties/invitations) for the repository [rchain/bounties](https://github.com/rchain/bounties) | ||
| 4. [ ] become a [member](https://groups.google.com/forum/#!pendingmember/rchain/join) of [email protected] for getting access to our documents | ||
|
|
||
| #### Decentralized Budget Allocation | ||
| ## Decentralized Budget Allocation | ||
|
|
||
| Voting and collecting rewards requires becoming a RChain Member and get verified on Discord. This requires a $20 membership fee and KYC. See [Becoming a Member](#becoming-a-member) below. | ||
| 1. [ ] <img src="https://user-images.githubusercontent.com/1913335/32598353-e489f158-c539-11e7-9656-4bcbb55718d2.png" alt="registration" width="200" /> | ||
| <!-- 2. [ ] This is the #bounties channel in Discord: | ||
|  --> | ||
| Voting and collecting rewards requires [verified membership in the RChain Coop](#becoming-a-member). | ||
|
|
||
| RHOC are distributed monthly based on invoices. | ||
|
|
||
| **Budgets are allocated to work items by at least three Members. The average of three votes defines the budget.** | ||
|
|
||
| - Budgets are allocated to work items by at least three Members. The average of three suggestions defines the budget. | ||
| - Ops (@lapin7, HJ) explains it in the video [RChain, Decentralized budgeting and spending](https://www.youtube.com/watch?v=m6xiTWbEdpA) | ||
| - Members suggest a budget to resolve the issue. | ||
| - Go to the spreadsheet [Pub Member Budget Allocation-Spending](https://docs.google.com/spreadsheets/d/1uxuxx8YN17KCIWcH1cUoGuSm2hAnIya2iAc6wxoaq1o/edit#gid=634479823) TAB "Budget 201711" | ||
|  | ||
| - Find an issue that you want to allocate a budget to, like #115 "Community Co-Operators" | ||
|
|
@@ -50,99 +46,49 @@ Voting and collecting rewards requires becoming a RChain Member and get verified | |
|  | ||
| - The Operation manager ([[email protected]]([email protected])) can also add comments with email assignments to the cells of the issue in this Gsheet in order to stimulate setting budgets. | ||
|
|
||
| #### Decentralized Reward Allocation | ||
| - RHOC are distributed monthly based on invoices. | ||
| - During the month each Member decides how the budget in RHOC is distributed over the collaborators as a reward for the participation. The average of three reward suggestions sets the personal reward for each collaborator. | ||
|
|
||
| ## Decentralized Reward Allocation | ||
|
|
||
| - During the month each Member may vote on what portion of the budget is distributed to each collaborator as a reward for their participation. **The average of (at least three) votes sets the personal reward for each collaborator.** | ||
|
|
||
| - Go to spreadsheet [Pub Member Budget Allocation-Spending](https://docs.google.com/spreadsheets/d/1uxuxx8YN17KCIWcH1cUoGuSm2hAnIya2iAc6wxoaq1o/edit#gid=634479823) TAB "Rewards 201711" | ||
|  | ||
| - In column Q and R you see respectively the percentage distribution and the github name of the member, who gave the score according to his/her insight about the work being done by him/her self and the other ones who have done work on the issue. | ||
| - In column M you can type your github name. Your name appears then in column Q for example. | ||
| - In column R you can set then the percentages for yourself and the other collaborators. | ||
| - [Ops]([email protected]) can also add comments with email assignments to the cells of the issue in this Gsheet in order to stimulate setting rewards. | ||
|
|
||
| #### Centralized Payment process | ||
|
|
||
| ## Centralized Payment process | ||
|
|
||
| - At the end of the month the situation will be frozen. No changes can be made anymore to either budgets or rewards. The payment process starts at the beginning of the month. | ||
| - The Member receives an email with a pre-filled invoice and also the needed data if the Member wants to make his/her own invoice. The collaborator stores a PDF version of the pre-filled invoice or their own invoice in his/her personal [Gdrive of Rchain](https://drive.google.com/drive/folders/0B5I9qM5f_1cfeUZoV01EYjdmOEE) Invoices. | ||
| - The Member then emails [[email protected]]([email protected]) with a link to the PDF invoice. | ||
| - If a Member does regular work per month, then a Statement of Work can be set up. This process will be available soon. | ||
| - If the process works well, then of course it will be decentralized further to work areas or regions. | ||
| - The final payment decision is at the discretion of the Operations Manager and Coop Officers. | ||
|
|
||
| ### Tax | ||
|
|
||
| #### Tax | ||
| - RChain Coop has to comply with the tax rules of the IRS. That means that at the end of the year RChain has to provide a list of payouts to contributors, with the amounts, through form 1099. | ||
| - If a contributor's rewards are more then $600 per year, then a [Fw9 tax form (For US citizens and residents)](https://www.irs.gov/pub/irs-pdf/fw9.pdf) has to be filled out [following the instructions here](https://www.irs.gov/instructions/iw9/index.html) and stored in the [personal folder](https://drive.google.com/drive/folders/0B5I9qM5f_1cfeUZoV01EYjdmOEE) Tax. | ||
| - For US aliens living outside of the USA, the [W-8BEN tax form](https://www.irs.gov/pub/irs-pdf/fw8ben.pdf) has to be filled out [following the instructions here](https://www.irs.gov/instructions/iw8ben). | ||
|
|
||
| NB: only lines 1, 2, 3, 4, and 7 are to be filled. | ||
| - As soon as the [Operation manager]([email protected]) is notified of the declaration, Ops will transfer RHOC to the provided ETH-addresses. | ||
|
|
||
| #### Reporting | ||
| ## Reporting | ||
| - Finally management reports will be generated and presented in Debriefings of RChain. | ||
|
|
||
| The first monthly cycle was Aug 2017. [Ops]([email protected]), (HJ or lapin7) presented this process Aug 30 in | ||
| [RChain Community Debrief 40 (24:06)](https://www.youtube.com/watch?v=7Li4g4qDF6M&t=1486s). An overview of the [budgets and rewards](https://docs.google.com/spreadsheets/d/1uxuxx8YN17KCIWcH1cUoGuSm2hAnIya2iAc6wxoaq1o/edit#gid=1751357908) is available. | ||
|
|
||
| #### Git Workflow | ||
|
|
||
| In this chapter is a brief introduction to the basic use of version management tool **git**. All contributors who want to contribute to rchain must follow the this git workflow. | ||
|
|
||
|  | ||
|
|
||
| **Fork** | ||
|
|
||
| visit[https://github.com/rchain/bounties](https://github.com/rchain/bounties), click `fork` button to fork the project to your own repository. | ||
|
|
||
| **Clone** | ||
|
|
||
| First create a working directory of the rchain project locally `mkdir rchain`, and then create your clone: | ||
|
|
||
| `cd rchain && git clone https://github.com/rchain/bounties.git` | ||
| ## Git Workflow: Pull Request Reviews Required | ||
|
|
||
| **Fetch && rebase** | ||
| All pull requests in this `rchain/bounties` repository require review | ||
| from collaborators. See GitHub documentation | ||
| [about pull request reviews][PRR]. | ||
|
|
||
| Get your local master up to date: | ||
| [PRR]: https://help.github.com/articles/about-pull-request-reviews/ | ||
|
|
||
| ``` | ||
| cd rchain/bounties | ||
| git fetch origin | ||
| git checkout master | ||
| git rebase origin/master | ||
| ``` | ||
|
|
||
| **Branch** | ||
|
|
||
| Branch from the master: | ||
|
|
||
| ``` | ||
| git checkout -b myfeature | ||
| ``` | ||
|
|
||
| Then edit code on the `myfeature` branch. | ||
|
|
||
| **Add && Commit** | ||
|
|
||
| Add all modified files and make a commit: | ||
|
|
||
| ``` | ||
| git add xxx.file | ||
| git commit -m "my commit message" | ||
| ``` | ||
|
|
||
| **Push** | ||
|
|
||
| When ready to review (or just to establish an offsite backup or your work), push your branch to your fork on `github.com`: | ||
|
|
||
| ``` | ||
| git push ${your_remote_name} myfeature | ||
| ``` | ||
|
|
||
| **create pull request** | ||
|
|
||
| 1. Visit your fork at <https://github.com/$user/bounties> | ||
| 2. Click the `Compare & Pull Request` button next to your `myfeature` branch. | ||
|
|
||
| **Reference** | ||
|
|
||
| For more detail about the git workflow, you can check the [developer git workflow](https://rchain.atlassian.net/wiki/spaces/DOC/pages/44007462/Github+Fork-n-Beans+Workflow). | ||
|
|
||
| ## Becoming a Member | ||
|
|
||
|
|
@@ -151,6 +97,7 @@ By joining the Cooperative you will participate in the lively conversation of th | |
| ### Process | ||
|
|
||
| - [Sign up](https://member.rchain.coop/#/sign-up) for RChain membership, upload your id document, and pay the $20 membership fee. | ||
| 1. [ ] <img src="https://user-images.githubusercontent.com/1913335/32598353-e489f158-c539-11e7-9656-4bcbb55718d2.png" alt="registration" width="200" /> | ||
| - You will receive an invite link to the RChain Discord. | ||
| - Create a [Discord](https://discordapp.com/) account if you don't have one. | ||
| - On Discord, you can send a message to the @verify bot: | ||
|
|
@@ -159,17 +106,17 @@ By joining the Cooperative you will participate in the lively conversation of th | |
| - On success, a 'verifier' will contact you (depending on the time of day this might not be immediate). | ||
| - After passing the verification, your role will be updated to Member. | ||
|
|
||
| #### 4 Membership requirements | ||
| ### 4 Membership requirements | ||
|
|
||
| The RChain representative will check the following: | ||
| 1. [Membership agreement](https://github.com/rchain/legaldocs/blob/master/Coop%20Membership%20Agreement.pdf) affirmed | ||
| 2. Check the photo of govt issued ID | ||
| 3. Verify payment of membership fee | ||
| 4. Verify face on live video | ||
|
|
||
| #### Promotion to MEMBER | ||
| ### Promotion to member role | ||
|
|
||
| When the four membership requirements are met and recorded, a Discord admin will promote the user to ROLE=MEMBER and append a ':' to the member's Discord alias for proof of individuality. | ||
| When the four membership requirements are met and recorded, a discord greeter will promote the user to role **member** and append a ':' to the member's Discord alias for proof of individuality. | ||
|
|
||
| Welcome to the club! | ||
| Welcome to the cooperative! | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,80 @@ | ||
| # RChain Members | ||
| # RChain Bounty Program | ||
|
|
||
| [](https://gitter.im/rchain/Members?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| In Aug 2017, the [RChain][] Cooperative president, [Greg Meredith][LGM], | ||
| dedicated funds to a distributed budget and reward system for working | ||
| together. We call the participants **RAMs**: RChain Active | ||
| Members. The rewards are intended to | ||
|
|
||
| This repository is meant for all organizational matters, like: | ||
| - defining how we work together | ||
| - how to become a coop Member | ||
| - how to earn RHOC | ||
| - etc. | ||
| 1. build a thriving open source developer community | ||
| 2. involve the creative community in telling the RChain story | ||
|
|
||
| The [issues](https://github.com/rchain/Members/issues) in this repository | ||
| are the basis of an emerging [market of RChain contributor work](CONTRIBUTING.md). | ||
| Not just code: [Marketing - Content Curation, Creation and Outreach][comm] | ||
| and any other ways to support the coop are welcome. | ||
| We consider it fair if the value you provide towards our goal is | ||
| proportional to the value you receive. All decision making is | ||
| transparent and decentralised. Every RAM is free to... | ||
|
|
||
| [Join our public Discord](https://discord.gg/fvY8qhx) or | ||
| [become a Member](https://member.rchain.coop/#/sign-up)! | ||
| We want you working on things you're excited about. | ||
| - Create new tasks (represented as | ||
| [issues](https://github.com/rchain/Members/issues) in github) that | ||
| they think will contribute towards achieving the goal. | ||
| - Vote on budgets for task issues — this values how much solving | ||
| that issue will contribute towards the goal. | ||
| - Vote on what portion of the budget should be rewarded to each | ||
| person that worked on executing the task issue. | ||
|
|
||
| [comm]: https://github.com/rchain/Members/projects/2 | ||
| Please briefly [introduce yourself](https://goo.gl/ffWXzD). | ||
|
|
||
| ## RChain Community Debrief | ||
| See | ||
| [CONTRIBUTING](https://github.com/rchain/Members/blob/master/CONTRIBUTING.md) | ||
| for details of the process for voting etc. | ||
|
|
||
| Every Wednesday the team joins in a hangout that streams | ||
| to [RChain’s youtube channel][youtube]. | ||
| Some important things that new RAMs should be aware of: | ||
|
|
||
| [youtube]: https://www.youtube.com/channel/UCSS3jCffMiz574_q64Ukj_w | ||
| - **Be a self-starter** :: because there is no boss, nobody is going | ||
| to tell you what to do. Being a RAM is much more like being an | ||
| _entrepreneur_ than it is like being a _employee_. | ||
| - The [greeter][] issues can help you find someone to show you | ||
| around initially. | ||
| - **Think for yourself** :: RAMs work together like a swarm of | ||
| insects does... but we need to avoid _herd-thinking_. We rely on | ||
| independent thinking, and speaking up when you think we're going | ||
| the wrong direction. Independent thought makes the coop stronger. | ||
| - **Get things Done** :: We value the guy that steps up and | ||
| _executes_. Having opinions is easy, but doing the work is hard. | ||
| - **Morals matter** :: The crypto space is a wild-west landscape, | ||
| where it's our own job to figure out our moral standards, and stick | ||
| to them. We believe in transparency, openness, and fairness. But | ||
| it’s ultimately up to our members to create and _guard_ those | ||
| values. | ||
| - **Be nice to each other** :: Most of our work happens online, | ||
| distributed, remote. Be nice to each other, and easy to | ||
| forgive. Even if you disagree, remember that we're all working | ||
| towards the same goal. | ||
|
|
||
| [Email Support](mailto:[email protected]) is available. | ||
|
|
||
| We keep an [index of debrief topics][debrief-ix] to help you get up to | ||
| speed. | ||
|
|
||
| [debrief-ix]: https://github.com/rchain/Members/wiki/Weekly-Debrief-Index | ||
| ### Nearby | ||
|
|
||
| ## About RChain | ||
| * [Official website](https://rchain.coop) | ||
| * [FAQ](https://github.com/rchain/reference/blob/master/faq.md) | ||
| * [RChain Architecture (latest)](http://rchain-architecture.readthedocs.io/) | ||
| * [Other reference documents](https://github.com/rchain/reference) | ||
| * [Articles of Incorporation, Bylaws, and board minutes](https://github.com/rchain/board) | ||
| * [Other legal documents](https://github.com/rchain/legaldocs) | ||
| - What is [RChain][]? | ||
| - [RChain][] is an emerging platform for scalable blockchain applications | ||
| - [RChain][] is a Cooperative | ||
| - [RChain Community Debrief][weekly] is a live event every | ||
| Wednesday, streamed to [RChain’s youtube channel][youtube]. We | ||
| keep an [index of topics][weekly] to help you navigate past events. | ||
| - [RChain FAQ](https://github.com/rchain/reference/blob/master/faq.md) | ||
| - [Discord](https://discord.gg/fvY8qhx) is the primary forum for coop members; | ||
| [@rchain_coop](https://twitter.com/rchain_coop) on Twitter and many | ||
| other [communications channels][chans] are popular. | ||
| - [RChain Organization][] | ||
| - [RChain Cooperative](https://rchain.coop) | ||
|
|
||
| ## Support | ||
| [greeter]: https://github.com/rchain/bounties/issues?utf8=%E2%9C%93&q=label%3Agreeter | ||
| [RChain]: https://github.com/rchain/bounties/wiki/RChain | ||
| [LGM]: https://github.com/rchain/bounties/wiki/Greg-Meredith | ||
| [RChain Organization]: https://github.com/rchain/bounties/wiki/RChain-Organization | ||
| [weekly]: https://github.com/rchain/Members/wiki/Weekly-Debrief-Index | ||
| [youtube]: https://www.youtube.com/channel/UCSS3jCffMiz574_q64Ukj_w | ||
| [chans]: https://github.com/rchain/reference/blob/master/communication_channels.md | ||
|
|
||
| * [GitHub Issues](https://github.com/rchain/Members/issues) | ||
| * Open an issue if you are having problems with this project. Suggestions are also welcome. | ||
| * [Email Support](mailto:[email protected]) | ||
|
|
||
| ## License | ||
|
|
||
|
|
||