From 99c73c01835e44823947298d3c25881d73683d00 Mon Sep 17 00:00:00 2001 From: nolim1t Date: Wed, 26 Feb 2020 10:51:25 +0700 Subject: [PATCH] Contributing policy for Umbrel box --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f7ad560 --- /dev/null +++ b/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) + +