Browse Source

Merge pull request #7 from getumbrel/contributing-policy

Contributing policy for Umbrel box
master
BT 5 years ago
committed by GitHub
parent
commit
231d1afc19
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 25
      CONTRIBUTING.md

25
CONTRIBUTING.md

@ -0,0 +1,25 @@
## How to contribute
#### **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/getumbrel/os-base/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/getumbrel/os-base/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 QA support on this project (as its painstakingly manual). See getting in touch below or just [create an issue](https://github.com/getumbrel/os-base/issues/new) and tag it with question.
#### **Getting in touch**
We accept contributions of all kinds, please contact us - [maintainer list here](https://github.com/getumbrel/os-base/graphs/contributors)
Loading…
Cancel
Save