Skip to content

Commit f954c3a

Browse files
authored
Update issue and feature request templates (#423)
1 parent 0fc5a9b commit f954c3a

File tree

2 files changed

+71
-27
lines changed

2 files changed

+71
-27
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+44-19
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,53 @@ labels: bug, needs triage
66
assignees: trufflesecurity/product-eng
77
---
88

9-
**Describe the bug**
10-
A clear and concise description of what the bug is.
9+
### Community Note
1110

12-
**To Reproduce**
13-
Steps to reproduce the behavior:
14-
1. Go to '...'
15-
2. Click on '....'
16-
3. Scroll down to '....'
17-
4. See error
11+
* 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
12+
* 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
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
1814

19-
**Expected behavior**
20-
A clear and concise description of what you expected to happen.
15+
### TruffleHog Version
16+
<!--- 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. --->
2117

22-
**Output**
23-
Please include relevant log output, and run with the `--debug` flag.
18+
### Trace Output
2419

25-
**Screenshots**
26-
If applicable, add screenshots to help explain your problem.
20+
<!---
21+
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.
2722
28-
**Desktop (please complete the following information):**
29-
- OS: [e.g. iOS]
30-
- Version [e.g. 22]
23+
To obtain the trace output, run trufflehog with the --trace flag.
24+
--->
25+
26+
### Expected Behavior
27+
28+
<!--- What should have happened? --->
29+
30+
### Actual Behavior
31+
32+
<!--- What actually happened? --->
33+
34+
### Steps to Reproduce
35+
36+
<!--- Please list the steps required to reproduce the issue. --->
37+
1. Go to '...'
38+
2. Click on '....'
39+
3. Scroll down to '....'
40+
4. See error
41+
42+
## Environment
43+
* OS: [e.g. iOS]
44+
* Version [e.g. 22]
45+
46+
## Additional Context
47+
<!--- Add any other context about the problem here. --->
48+
49+
### References
50+
51+
<!---
52+
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
53+
54+
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor documentation? For example:
55+
--->
56+
57+
* #0000
3158

32-
**Additional context**
33-
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

+27-8
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,33 @@ labels: enhancement, needs triage
66
assignees: trufflesecurity/product-eng
77
---
88

9-
**Is your feature request related to a problem? Please describe.**
10-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
### Community Note
1110

12-
**Describe the solution you'd like**
13-
A clear and concise description of what you want to happen.
11+
* 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
12+
* 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
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
1414

15-
**Describe alternatives you've considered**
16-
A clear and concise description of any alternative solutions or features you've considered.
15+
### Description
1716

18-
**Additional context**
19-
Add any other context or screenshots about the feature request here.
17+
<!--- Please leave a helpful description of the feature request here. --->
18+
19+
## Problem to be Addressed
20+
<!--- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --->
21+
22+
## Description of the Preferred Solution
23+
<!--- A clear and concise description of what you want to happen. What
24+
information may be required and what would be the preferred way to provide it?
25+
What should the output include? --->
26+
27+
## Additional Context
28+
<!--- Add any other context or screenshots about the feature request here. --->
29+
30+
### References
31+
32+
<!---
33+
Information about referencing Github Issues: https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests
34+
35+
Are there any other GitHub issues (open or closed) or pull requests that should be linked here? Vendor blog posts or documentation? For example:
36+
--->
37+
38+
* #0000

0 commit comments

Comments
 (0)