Browse Source

Add contributing guide

patch-1
nolim1t 5 years ago
parent
commit
3926118ce8
No known key found for this signature in database GPG Key ID: F6287B82CC84BCBD
  1. 28
      CONTRIBUTING.md

28
CONTRIBUTING.md

@ -0,0 +1,28 @@
## How to contribute to this project
#### **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/lncm/thebox-compose-system/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/lncm/thebox-compose-system/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and try to include a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
#### **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* If you haven't done a test build yet, please mention this in the pull request. This will save a world of pain for future builds. There is no regression testing suite set up yet but this is something that we're looking into. Contributions are welcome.
#### **I'm not a developer, what can I do to help?**
We could definetely use some UX, QA or Build Systems support on this project. See getting in touch below or just [create an issue](https://github.com/lncm/thebox-compose-system/issues/new) and tag it with question.
Or if you just want to donate some money please use [**bc1qsdlppqy9mhah5ljmhcmtpl20n9km8jz45n3qx3les3q2qfzpwm7qnruqnq**](https://blockchair.com/bitcoin/address/bc1qsdlppqy9mhah5ljmhcmtpl20n9km8jz45n3qx3les3q2qfzpwm7qnruqnq) or feel free to use [**Lightning via tippin.me**](https://tippin.me/@lncnx) .
#### **Getting in touch**
We accept contributions of all kinds, please contact us on [Twitter](https://twitter.com/lncnx) or contact one of us directly on Wire Messenger (userid: @corv , @nolim1t, or @meeDamian)
Main Repository Maintainer: [@nolim1t](https://github.com/nolim1t)
Loading…
Cancel
Save