Closes owtf#599. Adds Github PR and issues template.

+ Adds contribution guidelines + Adds issues and pull requests templates.
ph1ne4s · Mar 21, 2016 · e8bbbfd · e8bbbfd
1 parent 45e4bde
commit e8bbbfd
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,82 @@
+# Contributing to OWASP OWTF
+
+Looking to contribute something to OWTF? **Here's how you can help.**
+
+Please take a moment to review this document in order to make the contribution process easy
+and effective for everyone involved. These are just guidelines, not rules, use your
+best judgment and feel free to propose changes to this document in a pull request.
+
+Following these guidelines helps to communicate that you respect the time of the developers
+managing and developing this open source project. In return, they should reciprocate that
+respect in addressing your issue or assessing patches and features.
+
+For more detailed information, visit [OWTF wiki](https://github.com/owtf/owtf/wiki) or
+[user documentation](http://docs.owtf.org/en/latest/).
+
+#### Table Of Contents
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Using the issue tracker](#using-the-issue-tracker)
+  * [Your First Code Contribution](#your-first-code-contribution)
+  * [Pull Requests](#pull-requests)
+
+[Styleguides](#styleguides)
+  * [Git Commit Messages](#git-commit-messages)
+  * [Python Styleguide](#coffeescript-styleguide)
+  * [Documentation Styleguide](#documentation-styleguide)
+
+
+## How Can I Contribute?
+
+### Using the issue tracker
+
+The [issue tracker](https://github.com/owtf/owtf/issues) is the preferred channel for bug reports, features requests
+and submitting pull requests, but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests if possible.
+  [IRC](http://webchat.freenode.net/?randomnick=1&channels=%23owtf&prompt=1&uio=MTE9MjM20f) and email
+  are better places to get help.
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
+
+* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
+  Use [GitHub's "reactions" feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
+  instead. We reserve the right to delete comments which violate this rule.
+
+* Please **do not** open issues or pull requests regarding the code of other repositories in
+  [OWTF organisation](https://github.com/owtf) (open them in their respective repositories).
+
+* Please perform **a cursory search** to see if the problem has already been reported. If it has, add a comment to the
+  existing issue instead of opening a new one.
+
+
+### Your First Code Contribution
+
+Unsure where to begin contributing to OWTF? You can start by looking through these `beginner`, `easy-fix` and
+`help-wanted` issues:
+
+Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable
+proxy for impact a given change will have.
+
+### Pull Requests
+
+* Include screenshots in your pull request whenever possible.
+* Follow the [Python](#python-styleguide).
+* Follow the pull request template provided.
+* Document new code based on the [Documentation Styleguide](#documentation-styleguide)
+* End files with a newline.
+* Avoid platform-dependent code such as:
+    * Use `os.path.join()` to concatenate filenames.
+    * Use `tempfile.gettempdir()` rather than `/tmp/` when you need to reference the temporary directory.
+
+
+## Styleguides
+
+### Git Commit Messages
+
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally
+
+### Python Styleguide
+
+### Documentation Styleguide
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,36 @@
+<!--- Provide a general, concise summary of the issue in the Title above -->
+
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.-->
+<!--- Include code, screenshots or anything we may find helpful to reproduce the issue, if relevant -->
+1.
+2.
+3.
+4.
+
+## Logs
+<!--- Logs from /tmp/owtf/ and <owtf_root>/owtf_review/logs/ -->
+<!--- Do not paste the logs here - use a paste service like Pastie (http://pastie.org) -->
+
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Installation method used:
+* Version/branch used:
+* Operating System and version (like Kali, Debian, ArchLinux, etc):
+* pip/setuptools version:
+* sudo access:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,37 @@
+<!--- Provide a general, concise summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Related Issue
+<!--- This project only accepts pull requests related to open issues -->
+<!--- If suggesting a new feature or change, please discuss it in an issue first -->
+<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
+<!--- Please link to the issue here: -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+
+## Reviewers
+<!--- @mentions of the person/people responsible for reviewing proposed changes. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Screenshots (if appropriate):
+<!--- Before the change and after the change. -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+### Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style (modified PEP8) of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
diff --git a/README.md b/README.md
@@ -109,6 +109,7 @@ Links
 ===
 
 - [Project homepage](http://owtf.github.io/)
+- [IRC](http://webchat.freenode.net/?randomnick=1&channels=%23owtf&prompt=1&uio=MTE9MjM20f)
 - [Wiki](https://www.owasp.org/index.php/OWASP_OWTF)
 - [User Documentation](http://docs.owtf.org/en/latest/)
 - [Youtube channel](https://www.youtube.com/user/owtfproject)