Mirrors/sherlock
2
0
Fork 0
mirror of https://github.com/sherlock-project/sherlock synced 2024-11-21 19:33:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #2154 from ppfeister/feat/better-forms

Browse source 
Revamp issue forms
This commit is contained in:
Siddharth Dushantha 2024-06-04 19:19:40 +00:00 committed by GitHub
commit ef124acf34
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 102 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
.github/ISSUE_TEMPLATE/bug-report.yml vendored
View file

@ -1,52 +1,57 @@
name: Bug Report
name: Bug report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
- type: dropdown
id: package
attributes:
value: |
Thanks for taking the time to fill out this bug report!
label: Installation method
description: |
Some packages are maintained by the community, rather than by the Sherlock Project.
Knowing which packages are affected helps us diagnose package-specific bugs.
options:
- Select one
- 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
description: |
Detailed descriptions that help contributors understand and reproduce your bug are much more likely to lead to a fix.
Please include the following information:
- What you were trying to do
- What you expected to happen
- What actually happened
placeholder: |
When doing {action}, the expected result should be {expected result}.
When doing {action}, however, the actual result was {actual result}.
This is undesirable because {reason}.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Write a step by step list that will allow us to reproduce this bug
description: Write a step by step list that will allow us to reproduce this bug.
placeholder: |
1. Do something
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
description: If you have some additional information, please write it here.
validations:
required: true
required: false
- type: checkboxes
id: terms
attributes:

27
.github/ISSUE_TEMPLATE/false-negative.yml vendored
View file

@ -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
.github/ISSUE_TEMPLATE/false-positive.yml vendored
View file

@ -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
.github/ISSUE_TEMPLATE/feature-request.yml vendored
View file

@ -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:
@ -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

31
.github/ISSUE_TEMPLATE/site-request.yml vendored
View file

@ -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: input
id: site-name
- type: markdown
attributes:
label: Site name
description: What site should Sherlock support?
placeholder: Reddit
value: |
Ensure that the site name is in the title of your request. Requests without this information will be **closed**.
- type: input
id: site-url
attributes:
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:
@ -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