Git-Mirrors/haveno
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno.git synced 2025-09-19 04:24:57 -04:00
Code Issues Projects Releases Packages Wiki Activity

update documentation

Browse source 
- add initial docs/CONTRIBUTING.md
- update CODEOWNERS.md, README.md and bounties.md
- fix some issues found by codacy
This commit is contained in:
erciccione 2021-05-15 11:56:08 +02:00 • committed by woodser
parent b20abddcdd
commit e7ad539f66
4 changed files with 52 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/bounties.md
View file

@ -1,7 +1,10 @@
## Bounties
We use bounties to incentivize development. To receive a bounty, you agree to these conditions:
We use bounties to incentivize development and reward contributors. All issues available for a bounty are listed [on the Kanban board](https://github.com/orgs/haveno-dex/projects/2). It's possible to list on each repository the issues with a bounty on them, by searching issues with the '💰bounty' label.
To receive a bounty, you agree to these conditions:
- Your changes must follow the [styling guidelines](contributing.md).
- Bounties will be set and awarded at discretion of the Haveno core team.
- The issues eligible for a bounty are labelled '💰bounty' and have the amount of the bounty specified in the title in this form: `[$200]` if in dollars or `[ɱ20]` if in Monero.
- The first person who resolves an issue in its entirety will receive the entire amount of the bounty.
@ -11,11 +14,4 @@ We use bounties to incentivize development. To receive a bounty, you agree to th
- If a big number of bounties is claimed at the same time, the maintainers might opt for sending all the rewards on a specific day of the month instead of right after resolution.
- If the bounty is in dollars, the contributor will receive the amount in Monero according to the value of XMR at the moment the issue was practically resolved, so in the moment the maintainers accept the last patch resolving the issue.
You are also required to follow these styling guidelines:
- Be verbose. Remember this is collaborative development and we need to make life as easy as possible for future developers and for the current maintainers. Pull requests should contain as many details as possible about what you are going to change and why. Avoid "title only" PRs, unless they are self-explanatory.
- Pull requests should contain one single commit, unless it makes sense to have more. Please become familiar with git if you are not.
- All formatting needs to be consistent with the current code.
- Changes must be done 'the right way'. No hacks to make things work, if you are having issues, let the other devs know, so that we can help you out.
We want to keep the system simple and flexible, but we will add new rules or edit existing ones if necessary.