Merge pull request beefproject#1934 from beefproject/update_issue_template

Update Issue/PR templates

Author: jackdwalker

Diff for: .github/ISSUE_TEMPLATE.md

@@ -1,49 +1,66 @@
+# Submit Issue
+
 Verify first that your issue/request has not been posted previously:
 
 * https://github.com/beefproject/beef/issues
 * https://github.com/beefproject/beef/wiki/FAQ
 
 Ensure you're using the [latest version of BeEF](https://github.com/beefproject/beef/releases/tag/beef-0.5.0.0).
 
+Please do your best to provide as much information as possible. It will help substantially if you can enable and provide debugging logs with your issue. Instructions for enabling debugging logs are below:
 
-#### Environment
-
-What version/revision of BeEF are you using?
+1. In the `config.yaml` file of your BeEF root folder set debug and client_debug (lines 11 & 13 respectively) to `true`
+   * If using a standard installation of `beef-xss` the root folder will typicaly be `/usr/share/beef-xss`
+2. Reproduce your error
+3. Retrieve your client-side logs from your browser's developer console (Ctrl + Shift + I)
+4. Retrieve your server-side logs from `~/.beef/beef.log`
+5. **If using `beef-xss`:** Retrieve your service logs using `journalctl -u beef-xss`
 
-On what version of Ruby?
+Thank you, this will greatly aid us in identifying the root cause of your issue :)
 
-On what browser?
+**If we request additional information and we don't hear back from you within a week, we will be closing the ticket off.**
+Feel free to open it back up if you continue to have issues. 
 
-On what operating system?
+## Summary
 
+**Q:** Please provide a brief summary of the issue that you experienced.
+**A:**
 
-#### Configuration
+## Environment
 
-Are you using a non-default configuration?
+*Please identify the environment in which your issue occurred.*
 
-Have you enabled or disabled any BeEF extensions?
+1. **BeEF Version:**
 
+2. **Ruby Version:**
 
-#### Summary
+3. **Browser Details (e.g. Chrome v81.0):**
 
-Please provide a summary of the issue.
+4. **Operating System (e.g. OSX Catalina):**
 
 
-#### Expected Behaviour
+## Configuration
 
-What was the expected result?
+**Q:** Have you made any changes to your BeEF configuration? 
+**A:**
 
+**Q:** Have you enabled or disabled any BeEF extensions?
+**A:**
 
-#### Actual Behaviour
+## Expected vs. Actual Behaviour
 
-What was the actual result?
+**Expected Behaviour:** 
+<br />
+**Actual Behaviour:**
+<br />
 
+## Steps to Reproduce
 
-#### Steps to Reproduce
+*Please provide steps to reproduce this issue.*
 
-Please provide steps to reproduce this issue.
+1.
 
 
-#### Additional Information
+## Additional Information
 
-Please provide any additional information which may be useful in resolving this issue, such as debugging output and relevant screen shots. Debug output can be enabled by specifying `debug: true` in the `config.yaml` configuration file.
+Please provide any additional information which may be useful in resolving this issue, such as debugging output and relevant screen shots. Debug output can be retrieved by following the instructions towards the top of the issue template.

Diff for: .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 ...
-
-
-## 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
+**Q:** Give a technical rundown of what you have changed (if applicable)
+**A:**
 
-## 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
+## Test Cases
+**Q:** Describe your test cases, what you have covered and if there are any use cases that still need addressing.
+**A:**
 
-## 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.*