Git-Mirrors/haveno
1
0
Fork 0
mirror of https://github.com/haveno-dex/haveno.git synced 2025-06-04 21:29:48 -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

17
docs/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,17 @@
## Contributing to Haveno
Thanks for wishing to help! Here there are some guidelines and information about the development process. We suggest you to join the matrix room `#haveno-dev` (relayed on Freenode) and have a chat with the devs, so that we can help get you started.
Issues are tracked on GitHub. We use [a label system](https://github.com/haveno-dex/haveno/issues/50) and GitHub's [project boards](https://github.com/haveno-dex/haveno/projects) to simplify development. Make sure to take a look at those and to follow the priorities suggested.
### General 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.
- 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.
## Development process
- 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.
- Pull requests won't be merged before 24 hours has passed. This timeframe will be extended when Haveno will have more active developers.