diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index f7f9b82..0000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Report a bug in Sherlock's functionality -title: '' -labels: bug -assignees: '' - ---- - - - - -## Checklist - - -- [ ] I'm reporting a bug in Sherlock's functionality -- [ ] The bug I'm reporting is not a false positive or a false negative -- [ ] I've verified that I'm running the latest version of Sherlock -- [ ] I've checked for similar bug reports including closed ones -- [ ] I've checked for pull requests that attempt to fix this bug - -## Description - - -WRITE DESCRIPTION HERE diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..9dd7165 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,57 @@ +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! + - type: textarea + id: description + attributes: + label: Description + description: Describe the bug you are experiencing + placeholder: Something happend when I did something + 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 + 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 + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/false-negative.yml b/.github/ISSUE_TEMPLATE/false-negative.yml new file mode 100644 index 0000000..03d2122 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/false-negative.yml @@ -0,0 +1,20 @@ +name: False Negative +description: Report a site that is returning false negative results +labels: ["false negative"] +body: + - type: input + id: site-name + attributes: + label: Site name + description: What site is returning false negatives? + placeholder: Reddit + validations: + required: True + - 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... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/false-positive.yml b/.github/ISSUE_TEMPLATE/false-positive.yml new file mode 100644 index 0000000..e8bc458 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/false-positive.yml @@ -0,0 +1,20 @@ +name: Flase Positive +description: Report a site that is returning false positive results +labels: ["false positive"] +body: + - type: input + id: site-name + attributes: + label: Site name + description: What site is returning false positives? + placeholder: Reddit + validations: + required: True + - 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... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 67ec7ec..0000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature request -about: Request a new functionality for Sherlock -title: '' -labels: enhancement -assignees: '' - ---- - - - -## Checklist - -- [ ] I'm reporting a feature request -- [ ] I've checked for similar feature requests including closed ones - -## Description - - -WRITE DESCRIPTION HERE diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..654ac7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,12 @@ +name: Feature Request +description: Request a feature +labels: ["enhancement"] +body: + - type: textarea + id: description + attributes: + label: Description + description: Describe the feature you are requesting + placeholder: I'd like Sherlock to be able to do xyz + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 07cc2ee..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Question -about: Ask us a question -title: '' -labels: question -assignees: '' - ---- - - - -## Checklist - -- [ ] I'm asking a question regarding Sherlock -- [ ] My question is not a tech support question. - -**We are not your tech support**. -If you have questions related to `pip`, `git`, or something that is not related to Sherlock, please ask them on [Stack Overflow](https://stackoverflow.com/) or [r/learnpython](https://www.reddit.com/r/learnpython/) - - -## Question - -ASK YOUR QUESTION HERE diff --git a/.github/ISSUE_TEMPLATE/reporting-false-negative.md b/.github/ISSUE_TEMPLATE/reporting-false-negative.md deleted file mode 100644 index d511c5f..0000000 --- a/.github/ISSUE_TEMPLATE/reporting-false-negative.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Reporting false negative -about: Reporting a site that is returning false positives -title: '' -labels: false negative -assignees: '' - ---- - - - -## Checklist - -- [ ] I'm reporting a website that is returning **false negative** results -- [ ] I've checked for similar site support requests including closed ones -- [ ] I've checked for pull requests attempting to fix this false negative -- [ ] I'm only reporting **one** site (create a separate issue for each site) - -## Description - - -WRITE DESCRIPTION HERE diff --git a/.github/ISSUE_TEMPLATE/reporting-false-positive.md b/.github/ISSUE_TEMPLATE/reporting-false-positive.md deleted file mode 100644 index 7f968b5..0000000 --- a/.github/ISSUE_TEMPLATE/reporting-false-positive.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Reporting false positive -about: Reporting a site that is returning false positives -title: '' -labels: false positive -assignees: '' - ---- - - - -## Checklist - -- [ ] I'm reporting a website that is returning **false positive** results -- [ ] I've checked for similar site support requests including closed ones -- [ ] I've checked for pull requests attempting to fix this false positive -- [ ] I'm only reporting **one** site (create a separate issue for each site) - -## Description - - -WRITE DESCRIPTION HERE diff --git a/.github/ISSUE_TEMPLATE/site-request.yml b/.github/ISSUE_TEMPLATE/site-request.yml new file mode 100644 index 0000000..86d7b16 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/site-request.yml @@ -0,0 +1,20 @@ +name: Site Support +description: Request a site Sherlock should support +labels: ["site support request"] +body: + - type: input + id: site-name + attributes: + label: Site name + description: What site should Sherlock support? + placeholder: Reddit + validations: + required: True + - type: textarea + id: additional-info + attributes: + label: Additional info + description: If you have suggestions on how Sherlock should detect for usernames, please explain below + placeholder: Sherlock can detect if a username exists on Reddit by checking for... + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/site-support-request.md b/.github/ISSUE_TEMPLATE/site-support-request.md deleted file mode 100644 index 3810c55..0000000 --- a/.github/ISSUE_TEMPLATE/site-support-request.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Site support request -about: Request support for a new site -title: '' -labels: site support request -assignees: '' - ---- - - - -## Checklist - - -- [ ] I'm requesting support for a new site -- [ ] I've checked for similar site support requests including closed ones -- [ ] I've checked that the site I am requesting has not been removed in the past and is not documented in [removed_sites.md](https://github.com/sherlock-project/sherlock/blob/master/removed_sites.md) -- [ ] The site I am requesting support for is not a pornographic website -- [ ] I'm only requesting support of **one** website (create a separate issue for each site) - -## Description - - -URL: