diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..cf46fce2b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing Guidelines +*Pull requests and bug reports are highly encouraged, don't hesitate to create an issue if you're experiencing any bugs.* +## Contents +- [Issues](#issues) +- [Pull Requests](#pull-requests) + + + +# Issues +Before creating an issue, make sure you are using the latest available version of the project. If you have not yet updated, check if updating fixes your issue(s) first. + +# Pull Requests +- **Make sure you describe your changes clearly.** Its easier and much faster for everyone involved. +- **Test your changes properly.** If your changes introduce any new bugs that you know of, make sure to include them in the description of your pull request.