Skip to content

Commit

Permalink
Revamp forms
Browse files Browse the repository at this point in the history
  • Loading branch information
ppfeister committed Jun 2, 2024
1 parent 3b187d1 commit f15699a
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 48 deletions.
41 changes: 22 additions & 19 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,36 @@
name: Bug Report
name: Bug report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
Thoughtfully filled out reports with detailed steps to reproduce are much more likely to be fixed.
We can't fix what we can't reproduce!
- type: dropdown
id: package
attributes:
label: Installation method
description: Which package are you using?
options:
- PyPI (via pip)
- Homebrew
- Docker
- Kali repository (via apt)
- Built from source
- Other (indicate below)
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug you are experiencing
placeholder: Something happend when I did something
placeholder: |
When doing {action}, {expected result} is what I expected to happen, but {actual result} happened instead.
This is undesirable because {reason}.
validations:
required: true
- type: textarea
Expand All @@ -24,29 +43,13 @@ body:
2. Then do something else
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Explain how you expect Sherlock to behave
placeholder: I expect Sherlock to behave like this when that is done
validations:
required: true
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: Explain how Sherlock is acutally behaving
placeholder: Sherlock should be behaving like this when that is done
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional information
description: If you have some additional information, please write it here
validations:
required: true
required: false
- type: checkboxes
id: terms
attributes:
Expand Down
27 changes: 17 additions & 10 deletions .github/ISSUE_TEMPLATE/false-negative.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@
name: False Negative
name: False negative
description: Report a site that is returning false negative results
title: "False negative for: "
labels: ["false negative"]
body:
- type: input
id: site-name
- type: markdown
attributes:
label: Site name
description: What site is returning false negatives?
placeholder: Reddit
validations:
required: True
value: |
Please include the site name in the title of your issue.
Submit **one site per report** for faster resolution. If you have multiple sites in the same report, it often takes longer to fix.
- type: textarea
id: additional-info
attributes:
label: Additional info
description: If you know why the site is returning false negatives, please explain
placeholder: Reddit is returning false negatives because...
description: If you know why the site is returning false negatives, or noticed any patterns, please explain.
placeholder: |
Reddit is returning false negatives because...
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
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).
options:
- label: I agree to follow this project's Code of Conduct
required: true
28 changes: 18 additions & 10 deletions .github/ISSUE_TEMPLATE/false-positive.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
name: Flase Positive
name: False positive
description: Report a site that is returning false positive results
title: "False positive for: "
labels: ["false positive"]
body:
- type: input
id: site-name
- type: markdown
attributes:
label: Site name
description: What site is returning false positives?
placeholder: Reddit
validations:
required: True
value: |
Please include the site name in the title of your issue.
Submit **one site per report** for faster resolution. If you have multiple sites in the same report, it often takes longer to fix.
- type: textarea
id: additional-info
attributes:
label: Additional info
description: If you know why the site is returning false positives, please explain
placeholder: Reddit is returning false positives because...
description: If you know why the site is returning false positives, or noticed any patterns, please explain.
placeholder: |
Reddit is returning false positives because...
False positives only occur after x searches...
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
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).
options:
- label: I agree to follow this project's Code of Conduct
required: true
16 changes: 14 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
name: Feature Request
description: Request a feature
name: Feature request
description: Request a feature or enhancement
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Concise and thoughtful titles help other contributors find and add your requested feature.
- type: textarea
id: description
attributes:
Expand All @@ -10,3 +14,11 @@ body:
placeholder: I'd like Sherlock to be able to do xyz
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
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).
options:
- label: I agree to follow this project's Code of Conduct
required: true
29 changes: 22 additions & 7 deletions .github/ISSUE_TEMPLATE/site-request.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
name: Site Support
description: Request a site Sherlock should support
name: Reuest a new website
description: Request that Sherlock add support for a new website
title: "Requesting support for: "
labels: ["site support request"]
body:
- type: markdown
attributes:
value: |
Ensure that the site name is in the title of your request. Requests without this information will be **closed**.
- type: input
id: site-name
id: site-url
attributes:
label: Site name
description: What site should Sherlock support?
placeholder: Reddit
label: Site URL
description: |
What is the URL of the website indicated in your title?
Websites sometimes have similar names. This helps constributors find the correct site.
placeholder: https://reddit.com
validations:
required: True
required: true
- type: textarea
id: additional-info
attributes:
Expand All @@ -18,3 +25,11 @@ body:
placeholder: Sherlock can detect if a username exists on Reddit by checking for...
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
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).
options:
- label: I agree to follow this project's Code of Conduct
required: true

0 comments on commit f15699a

Please sign in to comment.