Skip to content

Commit ef124ac

Browse files
sdushanthasdushantha
authored
Merge pull request #2154 from ppfeister/feat/better-forms
Revamp issue forms
2 parents 3b187d1 + 8b9d482 commit ef124ac

File tree

5 files changed

+101
-54
lines changed

5 files changed

+101
-54
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,57 @@
1-
name: Bug Report
1+
name: Bug report
22
description: File a bug report
33
labels: ["bug"]
44
body:
5-
- type: markdown
5+
- type: dropdown
6+
id: package
67
attributes:
7-
value: |
8-
Thanks for taking the time to fill out this bug report!
8+
label: Installation method
9+
description: |
10+
Some packages are maintained by the community, rather than by the Sherlock Project.
11+
Knowing which packages are affected helps us diagnose package-specific bugs.
12+
options:
13+
- Select one
14+
- PyPI (via pip)
15+
- Homebrew
16+
- Docker
17+
- Kali repository (via apt)
18+
- Built from source
19+
- Other (indicate below)
20+
validations:
21+
required: true
922
- type: textarea
1023
id: description
1124
attributes:
1225
label: Description
13-
description: Describe the bug you are experiencing
14-
placeholder: Something happend when I did something
26+
description: |
27+
Detailed descriptions that help contributors understand and reproduce your bug are much more likely to lead to a fix.
28+
Please include the following information:
29+
- What you were trying to do
30+
- What you expected to happen
31+
- What actually happened
32+
placeholder: |
33+
When doing {action}, the expected result should be {expected result}.
34+
When doing {action}, however, the actual result was {actual result}.
35+
This is undesirable because {reason}.
1536
validations:
1637
required: true
1738
- type: textarea
1839
id: steps-to-reproduce
1940
attributes:
2041
label: Steps to reproduce
21-
description: Write a step by step list that will allow us to reproduce this bug
42+
description: Write a step by step list that will allow us to reproduce this bug.
2243
placeholder: |
2344
1. Do something
2445
2. Then do something else
2546
validations:
2647
required: true
27-
- type: textarea
28-
id: expected-behavior
29-
attributes:
30-
label: Expected behavior
31-
description: Explain how you expect Sherlock to behave
32-
placeholder: I expect Sherlock to behave like this when that is done
33-
validations:
34-
required: true
35-
- type: textarea
36-
id: actual-behavior
37-
attributes:
38-
label: Actual behavior
39-
description: Explain how Sherlock is acutally behaving
40-
placeholder: Sherlock should be behaving like this when that is done
41-
validations:
42-
required: true
4348
- type: textarea
4449
id: additional-info
4550
attributes:
4651
label: Additional information
47-
description: If you have some additional information, please write it here
52+
description: If you have some additional information, please write it here.
4853
validations:
49-
required: true
54+
required: false
5055
- type: checkboxes
5156
id: terms
5257
attributes:

‎.github/ISSUE_TEMPLATE/false-negative.yml‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
1-
name: False Negative
1+
name: False negative
22
description: Report a site that is returning false negative results
3+
title: "False negative for: "
34
labels: ["false negative"]
45
body:
5-
- type: input
6-
id: site-name
6+
- type: markdown
77
attributes:
8-
label: Site name
9-
description: What site is returning false negatives?
10-
placeholder: Reddit
11-
validations:
12-
required: True
8+
value: |
9+
Please include the site name in the title of your issue.
10+
Submit **one site per report** for faster resolution. If you have multiple sites in the same report, it often takes longer to fix.
1311
- type: textarea
1412
id: additional-info
1513
attributes:
1614
label: Additional info
17-
description: If you know why the site is returning false negatives, please explain
18-
placeholder: Reddit is returning false negatives because...
15+
description: If you know why the site is returning false negatives, or noticed any patterns, please explain.
16+
placeholder: |
17+
Reddit is returning false negatives because...
1918
validations:
2019
required: false
20+
- type: checkboxes
21+
id: terms
22+
attributes:
23+
label: Code of Conduct
24+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sherlock-project/sherlock/blob/master/docs/CODE_OF_CONDUCT.md).
25+
options:
26+
- label: I agree to follow this project's Code of Conduct
27+
required: true

‎.github/ISSUE_TEMPLATE/false-positive.yml‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
1-
name: Flase Positive
1+
name: False positive
22
description: Report a site that is returning false positive results
3+
title: "False positive for: "
34
labels: ["false positive"]
45
body:
5-
- type: input
6-
id: site-name
6+
- type: markdown
77
attributes:
8-
label: Site name
9-
description: What site is returning false positives?
10-
placeholder: Reddit
11-
validations:
12-
required: True
8+
value: |
9+
Please include the site name in the title of your issue.
10+
Submit **one site per report** for faster resolution. If you have multiple sites in the same report, it often takes longer to fix.
1311
- type: textarea
1412
id: additional-info
1513
attributes:
1614
label: Additional info
17-
description: If you know why the site is returning false positives, please explain
18-
placeholder: Reddit is returning false positives because...
15+
description: If you know why the site is returning false positives, or noticed any patterns, please explain.
16+
placeholder: |
17+
Reddit is returning false positives because...
18+
False positives only occur after x searches...
1919
validations:
2020
required: false
21+
- type: checkboxes
22+
id: terms
23+
attributes:
24+
label: Code of Conduct
25+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sherlock-project/sherlock/blob/master/docs/CODE_OF_CONDUCT.md).
26+
options:
27+
- label: I agree to follow this project's Code of Conduct
28+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
name: Feature Request
2-
description: Request a feature
1+
name: Feature request
2+
description: Request a feature or enhancement
33
labels: ["enhancement"]
44
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Concise and thoughtful titles help other contributors find and add your requested feature.
59
- type: textarea
610
id: description
711
attributes:
@@ -10,3 +14,11 @@ body:
1014
placeholder: I'd like Sherlock to be able to do xyz
1115
validations:
1216
required: true
17+
- type: checkboxes
18+
id: terms
19+
attributes:
20+
label: Code of Conduct
21+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sherlock-project/sherlock/blob/master/docs/CODE_OF_CONDUCT.md).
22+
options:
23+
- label: I agree to follow this project's Code of Conduct
24+
required: true

‎.github/ISSUE_TEMPLATE/site-request.yml‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
name: Site Support
2-
description: Request a site Sherlock should support
1+
name: Reuest a new website
2+
description: Request that Sherlock add support for a new website
3+
title: "Requesting support for: "
34
labels: ["site support request"]
45
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Ensure that the site name is in the title of your request. Requests without this information will be **closed**.
510
- type: input
6-
id: site-name
11+
id: site-url
712
attributes:
8-
label: Site name
9-
description: What site should Sherlock support?
10-
placeholder: Reddit
13+
label: Site URL
14+
description: |
15+
What is the URL of the website indicated in your title?
16+
Websites sometimes have similar names. This helps constributors find the correct site.
17+
placeholder: https://reddit.com
1118
validations:
12-
required: True
19+
required: true
1320
- type: textarea
1421
id: additional-info
1522
attributes:
@@ -18,3 +25,11 @@ body:
1825
placeholder: Sherlock can detect if a username exists on Reddit by checking for...
1926
validations:
2027
required: false
28+
- type: checkboxes
29+
id: terms
30+
attributes:
31+
label: Code of Conduct
32+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sherlock-project/sherlock/blob/master/docs/CODE_OF_CONDUCT.md).
33+
options:
34+
- label: I agree to follow this project's Code of Conduct
35+
required: true

0 commit comments

Comments
 (0)