Skip to content

Commit

Permalink
Merge pull request #1176 from ONEARMY/docs/bounties
Browse files Browse the repository at this point in the history
Add bounty docs
  • Loading branch information
davehakkens authored Jun 21, 2021
2 parents 87e5f0b + 79b7c07 commit ba6aa3a
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
56 changes: 56 additions & 0 deletions BOUNTIES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Feature Bounties
As a way of saying thanks to developers for their time, we've implemented a small bounty system to reward feature development.

## How much are they?
We currently have 3 bounty levels

| Level | Amount | It should take... | E.g. |
|---|---|---|---|
| 1 | €20 | Roughly 1-2 hours work for a junior/intermediate developer | Small bugfixes, UI tweaks |
| 2 | €40 | Roughly 3-5 hours work for an intermediate/senior developer | Minor feature, e.g. Howto search |
| 3 | €85 | Roughly 6+ hours work for a more senior developer | Major feature, e.g. Research module |

----

## How do I find bounty issues?
Simply go to the `Issues` page on github and look for issues with labelled with [Bounty](https://github.com/ONEARMY/community-platform/labels/bounty).

_Note_ - the exact bounty level is not included as knowing in advance how much work will be involved is hard! Instead we assign levels collectively on the monthly developer call.

----

## How do I claim them?

### Step 1 - Assigned the issue
Drop a message in the issue thread to say that you are interested taking it on. If the issue is already assigned, or we think it might be too much for a new or individual contributor we might suggest looking at other issues instead. Otherwise it's all yours :D

### Step 2 - Do the work
Once assigned try to complete the issue within the next month. Once complete make a PR, which will get reviewed and merged (maybe with some minor edits requested, or new issues created for future dev work)

### Step 3 - Register on open collective
We handle payments through [Open Collective](https://opencollective.com/onearmy). Follow the link and register as a contributor to the project. You can add your paypal or bank details there which will be used to

### Step 4 - (optional) Join our monthly dev call
If you want more feedback on the issue or suggested bounty levels, we have a monthly call welcome for all developers to join. After the call we will finalise the bounties and organise the admin.

### Step 5 - Receive payment

----
## What if I don't want the bounty?
No problem, if we haven't heard anything from you we'll just keep a record of the bounty and try reach out to see what you would like done with it.

If you just want the bounty to go back in to the community program we can do that, or if you want the bounty to be contributed to somewhere else (e.g. another charity or social cause) then we can also try make arrangements with you.

---
## What if I want to contribute in other ways?
That's awesome! As well as the bounty system we also encourage anyone interested to join our Core Developers or Maintainers team.

These roles include tasks like:
- Code reviews
- Code quality improvements
- Devops and general optimisations
- Security and general updates
- Documentation
- Issue management

There is a separate hourly payscale for these roles, aimed at developers who help a bit more consistently at around 2-3h per week. If you're interested in these roles then feel free to reach out on slack or during the monthly dev call.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ If you think something is missing, consider sending us a PR.
- [Backend](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#backend)
- [Getting started](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--getting-started)
- [Issue Tracking and Management](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--issue-tracking-and-management)
- [Development Bounties](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--dev-bounties)
- [Project structure](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--project-structure)
- [Branch structure](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--branch-structure)
- [Javascript style guide](https://github.com/ONEARMY/community-platform/blob/master/CONTRIBUTING.md#--javascript-style-guide)
Expand Down Expand Up @@ -79,6 +80,9 @@ When you start working on an issue, comment on it or if your are a registered co

When a group of issues have been resolved a pull request to the master branch should be made, where it will undergo a quick review and test. It is expected that the developer will have done thorough testing themselves first, this helps make sure most pull requests get merged quickly.

## 🤑   Development Bounties
We have a small bounty system as a way of saying thanks to developers for contributiong their time and code. Find out more about it in [Bounties](./BOUNTIES.md)

## 🏠   Project Structure

- **`scripts`** & **`config`** : contains build-related scripts and configuration files. Usually, you don't need to touch them.
Expand Down

0 comments on commit ba6aa3a

Please sign in to comment.