From 47bfca112d8f14ab697e3c0263e9c3ea10230116 Mon Sep 17 00:00:00 2001 From: Daniel Goldberg Date: Tue, 16 Jan 2018 19:37:40 +0200 Subject: [PATCH] Basic contributing.md Inspiration taken from Metasploit's amazing page. --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b4f69c1e9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Hi there + +Thanks for your interest in making the Monkey -- and therefore, your network -- a better place! + +Are you about to report a bug? Sorry to hear it. Here's our [Issue tracker]. +Please try to be as specific as you can about your problem; try to include steps +to reproduce. While we'll try to help anyway, focusing us will help us help you faster. + +If you want to contribute new code or fix bugs.. + + +## Submitting code + +The following is a *short* list of recommendations. PRs that don't match these criteria won't be closed but it'll be harder to merge the changes into the code. + +* **Do** stick to [PEP8](https://www.python.org/dev/peps/pep-0008/). +* **Do** target your pull request to the **develop branch**. +* **Do** specify a descriptive title to make searching for your pull request easier. +* **Do** list verification steps so your code is testable. +* **Don't** leave your pull request description blank. +* **Do** license your code as GPLv3. + + + +## Issues +* **Do** write a detailed description of your bug and use a descriptive title. +* **Do** include reproduction steps, stack traces, and anything else that might help us verify and fix your bug. + +Thank you for reading this before opening an issue or a PR, you've already doing good!