From 556b0972218d8019f25ad4897f9b6f47a911fc1f Mon Sep 17 00:00:00 2001 From: Ben Boyter Date: Mon, 12 Feb 2018 13:53:18 +1100 Subject: [PATCH] Add contributing file --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..774ca87 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +## How to contribute to licensechecker (lc) + +#### **Did you find a bug?** + +* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/boyter/lc/issues). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/boyter/lc/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and 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. + +* Before submitting, please specify that you explicitly licence your contribution under GPL-3.0-only. + +* If you include compatible code from a third party souce with an altunate license please add a SDPX tag to indicate this, see https://github.com/boyter/lc/blob/master/parsers/helpers.go bytesToHuman function as a reference exmaple. + + +#### **Always remember** + +* Do as Bill and Ted and be excellent to each other. + +Thanks!