Revamp forms

6 months ago · f15699a4f4
parent 3b187d1abc
commit f15699a4f4
5 changed files with 93 additions and 48 deletions
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@ -1,4 +1,4 @@
-name: Bug Report
+name: Bug report
 description: File a bug report
 labels: ["bug"]
 body:
@ -6,12 +6,31 @@ body:
    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
@ -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:
--- a/.github/ISSUE_TEMPLATE/false-negative.yml
+++ b/.github/ISSUE_TEMPLATE/false-negative.yml
@ -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
--- a/.github/ISSUE_TEMPLATE/false-positive.yml
+++ b/.github/ISSUE_TEMPLATE/false-positive.yml
@ -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
--- a/.github/ISSUE_TEMPLATE/feature-request.yml
+++ b/.github/ISSUE_TEMPLATE/feature-request.yml
@ -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
--- a/.github/ISSUE_TEMPLATE/site-request.yml
+++ b/.github/ISSUE_TEMPLATE/site-request.yml
@ -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:
@ -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