diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 27bc46604..fe9f18916 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,26 +1,20 @@ +# Pull Request + Thanks for submitting a PR! Please fill in this template where appropriate: ## Category - -(Bug / module / extension / core functionality / documentation / tests) +*e.g. Bug, Module, Extension, Core Functionality, Documentation, Tests* ## Feature/Issue Description +**Q:** Please give a brief summary of your feature/fix +**A:** -This Module is added to ... -This Extension is used by doing ... -This Bug can be reproduced by ... -The Documentation describes ... -This Test covers ... +**Q:** Give a technical rundown of what you have changed (if applicable) +**A:** +## Test Cases +**Q:** Describe your test cases, what you have covered and if there are any use cases that still need addressing. +**A:** -## Describe what changes -Describe how the change affects BeEF's usability ... -Describe how to replicate the issue/bug that this is fixing ... -Describe what this improves - -## Test cases -Describe what the goal of the test is, what it covers and if there are any use cases that still need to be covered. -spec/beef/extensions/example_extension.rb - -## Relevant wiki page -If it is not easily understandable without little pre-knowledge or context, there should be a section in the Wiki somewhere explaining it. +## Wiki Page +*If you are adding a new feature that is not easily understood without context, please draft a section to be added to the Wiki below.*