Skip to content

Find, verify, and analyze leaked credentials

Update issue and feature request templates (#423)

Bill Richf954c3a0f3ce
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 4b48bee3c..4e5487290 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,28 +6,53 @@ labels: bug, needs triage
assignees: trufflesecurity/product-eng
---
-**Describe the bug**
-A clear and concise description of what the bug is.
+### Community Note
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+* Please vote on this issue by adding a πŸ‘ [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+### TruffleHog Version
+<!--- Please run `trufflehog --version` to show the version. If you are not running the latest version, please upgrade because your issue may have already been fixed. --->
-**Output**
-Please include relevant log output, and run with the `--debug` flag.
+### Trace Output
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+<!---
+Please provide a link to a GitHub Gist containing the complete debug output. Please do NOT paste the debug output in the issue; just paste a link to the Gist.
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
+To obtain the trace output, run trufflehog with the --trace flag.
+--->
+
+### Expected Behavior
+
+<!--- What should have happened? --->
+
+### Actual Behavior
+
+<!--- What actually happened? --->
+
+### Steps to Reproduce
+
+<!--- Please list the steps required to reproduce the issue. --->
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. Scroll down to '....'
+ 4. See error
+
+## Environment
+ * OS: [e.g. iOS]
+ * Version [e.g. 22]
+
+## Additional Context
+<!--- Add any other context about the problem here. --->
+
+### References
+
+<!---
+Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
+
+Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? For example:
+--->
+
+* #0000
-**Additional context**
-Add any other context about the problem here.
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index de65d0a17..ee1224f1c 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,14 +6,33 @@ labels: enhancement, needs triage
assignees: trufflesecurity/product-eng
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+### Community Note
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+* Please vote on this issue by adding a πŸ‘ [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
+* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
+* If you are interested in working on this issue or have submitted a pull request, please leave a comment
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+### Description
-**Additional context**
-Add any other context or screenshots about the feature request here.
\ No newline at end of file
+<!--- Please leave a helpful description of the feature request here. --->
+
+## Problem to be Addressed
+<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->
+
+## Description of the Preferred Solution
+<!--- A clear and concise description of what you want to happen. What
+information may be required and what would be the preferred way to provide it?
+What should the output include? --->
+
+## Additional Context
+<!--- Add any other context or screenshots about the feature request here. --->
+
+### References
+
+<!---
+Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
+
+Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
+--->
+
+* #0000