From cb62e42ee884a0f38f0afd39ec4dcab526da8300 Mon Sep 17 00:00:00 2001 From: amanpro30 Date: Sat, 13 Mar 2021 16:21:33 +0530 Subject: [PATCH] Update Contribution Guidelines --- docs/CONTRIBUTING.md | 73 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 72 insertions(+), 1 deletion(-) mode change 100644 => 100755 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md old mode 100644 new mode 100755 index 79d3ded..92885c1 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,6 +2,77 @@ Thanks for checking out the Intelligent Intrusion Detection System! We're excited to hear and learn from you. Your experiences will definitely be a great addition to the project development and the users. +Thank you for taking the time to contribute! + +- [Contributing to OWASP-IIDS](#contributing-to-owasp-iids) + - [Suggesting a feature](#suggesting-a-feature) + - [Filing a bug report](#filing-a-bug-report) + - [Submitting a pull request](#submitting-a-pull-request) + - [Do](#do) + - [Don't](#dont) + - [Licensing](#licensing) + - [Submitting your code](#submitting-your-code) + - [Community](#community) + - [Thank you!](#thank-you) + +## Suggesting a feature + +We can't think of everything. If you've got a good idea for a feature, then please let us know! + +When suggesting a feature, make sure to: + +* Check the code on GitHub to make sure it's not already hiding in an unreleased version ;) +* Considered if it's necessary in the library, or is an advanced technique that could be separately explained in an example +* Check existing issues, open and closed, to make sure it hasn't already been suggested + +## Filing a bug report + +Please raise an Issue to let us know. Be as detailed as possible, and be ready to answer questions when we get back to you. Make sure you: + +* Tell us which OS you're using +* Tell us which Kernel you're running +* Tell us which Python version you're using +* List the steps you've taken so far, +* and any solutions you've tried +* And a paste/picture of the complete output from the failing script/library might help, too! + +## Submitting a pull request + +If you've decided to fix a bug, even something as small as a single-letter typo then great! Anything that improves the code/documentation for all future users is warmly welcomed. + +If you decide to work on a requested feature it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request. + +If you want to contribute an example; go for it! We might not always be able to accept your code, but there's a lot to be learned from trying anyway and if you're new to GitHub we're willing to guide you on that journey. + +When contributing a new example or making a change to a library please keep your code style consistent with ours. We try to stick to the pep8 guidelines for Python (https://www.python.org/dev/peps/pep-0008/). + +#### Do + +* Do use pep8 style guidelines +* Do comment your code where necessary +* Do submit only a single example/feature per pull-request +* Do include a description of what your example is expected to do + +#### Don't + +* Don't include any license information in your examples- our repositories are MIT licensed +* Don't try to do too much at once- submit one or two examples at a time, and be receptive to feedback +* Don't submit multiple variations of the same example, demonstrate one thing concisely + +### Licensing + +When you submit code to our libraries, you implicitly and irrevocably agree to adopt the associated licenses. You should be able to find this in the file named `LICENSE`. + +We typically use the MIT license; which permits Commercial Use, Modification, Distribution and Private use of our code, and therefore also your contributions. It also provides good compatibility with other licenses, and is intended to make re-use of our code as painless as possible for all parties. + +You can learn more about the MIT license at Wikipedia: https://en.wikipedia.org/wiki/MIT_License + +### Submitting your code + +Once you're ready to share your contribution with us you should submit it as a Pull Request. + +* Be ready to receive and embrace constructive feedback. +* Be prepared for rejection; we can't always accept contributions. If you're unsure, ask first! ## Community @@ -9,4 +80,4 @@ Discussions about the Open Source Guides take place on this repository's [Issues Wherever possible, do not take these conversations to private channels, including contacting the maintainers directly. Keeping communication public means everybody can benefit and learn from the conversation. - +## Thank you!