mirror of
https://github.com/trufflesecurity/trufflehog.git
synced 2024-11-10 15:14:38 +00:00
Update issue and feature request templates (#423)
This commit is contained in:
Bill Rich
GitHub
parent
0fc5a9bd13
commit
f954c3a0f3
2 changed files with 71 additions and 27 deletions
63
.github/ISSUE_TEMPLATE/bug_report.md
vendored
63
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -6,28 +6,53 @@ labels: bug, needs triage
|
||||||
assignees: trufflesecurity/product-eng
|
assignees: trufflesecurity/product-eng
|
||||||
---
|
---
|
||||||
|
|
||||||
**Describe the bug**
|
### Community Note
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**To Reproduce**
|
* 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
|
||||||
Steps to reproduce the behavior:
|
* 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
|
||||||
1. Go to '...'
|
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
### TruffleHog Version
|
||||||
A clear and concise description of what you expected to happen.
|
<!--- 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**
|
### Trace Output
|
||||||
Please include relevant log output, and run with the `--debug` flag.
|
|
||||||
|
|
||||||
**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):**
|
To obtain the trace output, run trufflehog with the --trace flag.
|
||||||
- OS: [e.g. iOS]
|
--->
|
||||||
- Version [e.g. 22]
|
|
||||||
|
### 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.
|
|
||||||
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
35
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -6,14 +6,33 @@ labels: enhancement, needs triage
|
||||||
assignees: trufflesecurity/product-eng
|
assignees: trufflesecurity/product-eng
|
||||||
---
|
---
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
### Community Note
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
* 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
|
||||||
A clear and concise description of what you want to happen.
|
* 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**
|
### Description
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
|
|
||||||
**Additional context**
|
<!--- Please leave a helpful description of the feature request here. --->
|
||||||
Add any other context or screenshots about 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
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue