From b8c8d7a4f2b95fa4588287aa241ea275e85c323a Mon Sep 17 00:00:00 2001 From: Richard Hagen Date: Thu, 28 Nov 2024 16:12:57 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..76851a2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# How to contribute to this repo + +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Reporting a bug +- Proposing new features +- Discussing the current state of the code +- Submitting a fix + +This is how you should do it: + +Use our [issue list](../../issues) to report a **bug** or **propose a new feature**, including + +### For **bug report** +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can +- What you expected would happen +- What actually happens + +The team love thorough bug reports - no it's not a joke! + +### For **feature request** +- Brief description of the feature +- What problem/issue will this solve +- A sort of Definition of Done - "How should it look when finsihed" + +### When submitting a fix using a Pull Request (PR) + +- Fork this repository from GitHub +- Once, you have a local copy (after forking) you can make edits to the code, make formatting changes, reorganise the code, add documentation etc … +- After you have made the changes, you have to create a pull request + +We will review the pull request and if it appropriate and there are no clashes or vulnerabilities, it will be merged to the main code + +Voila! you have contributed to a piece of software and the cycle repeats.