Update PR template (#951)

* Update PR template

* Update Developers.md

---------

Co-authored-by: Sam Stepanyan <[email protected]>

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +1,44 @@
-#### Checklist
-- [ ] I have followed the [Contributor Guidelines](https://github.com/OWASP/Nettacker/wiki/Developers#contribution-guidelines).
-- [ ] The code has been thoroughly tested in my local development environment with flake8 and pylint.
-- [ ] The code is Python 3 compatible.
-- [ ] The code follows the PEP8 styling guidelines with 4 spaces indentation.
-- [ ] This Pull Request relates to only one issue or only one feature
-- [ ] I have referenced the corresponding issue number in my commit message
-- [ ] I have added the relevant documentation.
-- [ ] My branch is up-to-date with the Upstream master branch.
-
-#### Changes proposed in this pull request
-
-#### Your development environment
-- OS: `x`
-- OS Version: `x`
-- Python Version: `x`
+<!--
+  Thanks for contributing to OWASP Nettacker!
+-->
+
+## Proposed change
+
+<!--
+  Describe the big picture of your changes.
+  Don't forget to link your PR to an existing issue if any.
+-->
+
+Your PR description goes here.
+
+## Type of change
+
+<!--
+  Type of change you want to introduce. Please, check one (1) box only!
+  If your PR requires multiple boxes to be checked, most likely it needs to
+  be split into multiple PRs.
+-->
+
+- [ ] New core framework functionality
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] Code refactoring without any functionality changes
+- [ ] New or existing module/payload change
+- [ ] Localization improvement
+- [ ] Dependency upgrade
+- [ ] Documentation improvement
+
+## Checklist
+
+<!--
+  Put an `x` in the boxes that apply. You can change them after PR is created.
+-->
+
+- [ ] I've followed the [contributing guidelines][contributing-guidelines]
+- [ ] I've run `make pre-commit`, it didn't generate any changes
+- [ ] I've run `make test`, all tests passed locally
+
+<!--
+  Thanks again for your contribution!
+-->
+
+[contributing-guidelines]: https://nettacker.readthedocs.io/en/latest/Developers/

Makefile

@@ -0,0 +1,5 @@
+pre-commit:
+	pre-commit run --all-files
+
+test:
+	poetry run pytest

docs/Developers.md

@@ -1,45 +1,40 @@
-We gladly support and appreciate anyone is interested to contribute to the OWASP Nettacker Project. Overall developers may focus on developing core framework, modules or payloads, language libraries and media. After reading this document you should be able to get the basic knowledge to start developing. Please consider that we are using PEP8 python code style and using [Codacy](https://app.codacy.com/app/zdresearch/OWASP-Nettacker/dashboard) to figure the code quality. In addition, [GitHub Actions](https://github.com/OWASP/Nettacker/actions) will check your PR automatically on several Python versions (2.x, 3.x). Before sending your PR, make sure you added **code-based documentation** to your codes and read the PR template. If you use any code/library/module with a license, add the license into external license file.
+We gladly support and appreciate anyone who is interested in contributing to OWASP Nettacker. Overall contributors may focus on developing core framework, modules or payloads, language libraries, and media. After reading this document you should be able to get the basic knowledge to start developing. Please note that we are using PEP8 Python code style and [GitHub Actions](https://github.com/OWASP/Nettacker/actions) for checking all new PRs automatically against supported Python versions. If you use any code/library/module with a license, add the license into external license file.
+
+* [Code of Conduct](https://github.com/OWASP/Nettacker/blob/master/CODE_OF_CONDUCT.md)
+* [Issue Template](https://github.com/OWASP/Nettacker/blob/master/.github/ISSUE_TEMPLATE.md)
+* [PR Template](https://github.com/OWASP/Nettacker/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+* [License](https://github.com/OWASP/Nettacker/blob/master/LICENSE)
+* [External Licenses](https://github.com/OWASP/Nettacker/blob/master/EXTERNAL_LIBRARIES_LICENSES.md)
 
-* [Code of Conduct](https://github.com/zdresearch/OWASP-Nettacker/blob/master/CODE_OF_CONDUCT.md)
-* [Issue Template](https://github.com/zdresearch/OWASP-Nettacker/blob/master/ISSUE_TEMPLATE.md)
-* **[PR Template](https://github.com/zdresearch/OWASP-Nettacker/blob/master/PULL_REQUEST_TEMPLATE.md)**
-* [License](https://github.com/zdresearch/OWASP-Nettacker/blob/master/LICENSE)
-* [External Licenses](https://github.com/zdresearch/OWASP-Nettacker/blob/master/EXTERNAL_LIBRARIES_LICENSES.md)
 ________
-- [Contribution Guidelines](#contribution-guidelines)
-- [Roadmap](#roadmap)
-- [Creating Media](#creating-media)
-- [Contribute to Language Libraries](#contribute-to-language-libraries)
+
+* [Contribution Guidelines](#contribution-guidelines)
+* [Roadmap](#roadmap)
+* [Creating Media](#creating-media)
+* [Contribute to Language Libraries](#contribute-to-language-libraries)
   * [Add a New Language Library](#add-a-new-language-library)
   * [Modify/Update Language Libraries](#modify-update-language-libraries)
 
-
 # Contribution Guidelines
+
 These are the guidelines you need to keep in mind while contributing:
-- The code must have been thoroughly tested in your local development environment.
-- The code must be both python 2 and 3 compatible.
-- The code must follow the PEP8 styling guidelines with a 4 spaces indentation.
-- Each pull request should have only one commit related to each update.
-- Please open different pull requests for individual updates.
-- The commit messages should be meaningful.
-- Be sure to add the concerned documentation for the added feature.
-- The branch in the pull request must be up-to-date with the `master` of Upstream.
-- Please follow the clean code guidelines [1](https://github.com/rmariano/Clean-code-in-Python/blob/master/build/Clean%20code%20in%20Python.pdf) and [2](https://github.com/zedr/clean-code-python).
-
-For any doubts regarding the guidelines please contact the project leaders.
 
-# Roadmap
+* Use the automated checks: run `make pre-commit` and `make test`
+* Thoroughly test your code locally.
+* Be sure to add/update related documentation.
+
+In case of any doubts regarding the guidelines please contact the project leaders.
 
-Developers always could be aware of the OWASP Nettacker project roadmap by checking
+# Roadmap
 
-* 1- Project Management Page https://github.com/OWASP/Nettacker/projects
-* 2- Issues Page https://github.com/OWASP/OWASP-Nettacker/issues
+Developers always could be aware of the OWASP Nettacker roadmap by checking
 
-To contribute OWASP Nettacker. Existing Issues, Tasks, Code Style Issues are great opportunity to start developing the OWASP Nettacker.
+* 1- Project Management Page <https://github.com/OWASP/Nettacker/projects>
+* 2- Issues Page <https://github.com/OWASP/OWASP-Nettacker/issues>
 
 # Creating Media
 
-We appreciated all kind of media to demonstrate the OWASP Nettacker in any language and environment. It is a great activity to help us grow our framework and get more publicity. Currently, we collected a few media on [Media](https://github.com/zdresearch/OWASP-Nettacker/wiki/Media) page. Feel free to post your Media on [this](https://github.com/zdresearch/OWASP-Nettacker/issues/1) page.
+We appreciated all kind of media to demonstrate the OWASP Nettacker in any language and environment. It is a great activity to help us grow our framework and get more publicity. Currently, we collected a few media on [Media](https://github.com/OWASP/Nettacker/wiki/Media) page. Feel free to post your Media on [this](https://github.com/OWASP/Nettacker/issues/1) page.
 
 # Contribute to Language Libraries
 
@@ -56,7 +51,7 @@ In some cases language library does not exist, you can create a new file and add
 
 ## Modify/Update Language Libraries
 
-To contribute to the existing libraries, You may go to `lib/messages` select the file you want to contribute and 
+To contribute to the existing libraries, You may go to `lib/messages` select the file you want to contribute and
 
 * 1- Translate English messages to the selected language.
 * 2- Compare the language library with **English** library and add new messages to this library and translate them.
@@ -173,7 +168,6 @@ lib.get(verify=False, timeout=3, cert="", stream=False, proxies="", url="http://
 
 ```
 
-
 # Contribute to Code Functionality & API & WebUI
 
-go nuts!
+Go nuts!