From ec5626097a66e4723f5dadbafb5b1d976458d6a7 Mon Sep 17 00:00:00 2001 From: TheTechRobo <52163910+TheTechRobo@users.noreply.github.com> Date: Tue, 4 Jan 2022 12:39:49 -0500 Subject: [PATCH 1/2] Create bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 79 +++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ef602de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,79 @@ +name: Bug report +description: Create a report to help us improve +labels: 'bug' +body: + - type: markdown + attributes: + value: | + ## Self Check + - Try searching existing GitHub Issues (open or closed) for similar issues. + - type: textarea + validations: + required: true + attributes: + label: Describe the bug + description: A clear description of what the bug is. + placeholder: e.g. I see an AssertionError when trying to scrape a Twitter user! + - type: textarea + validations: + required: true + attributes: + label: How to reproduce + description: | + How to reproduce the problem. + placeholder: e.g. I can reproduce this issue by scraping the textfiles user with the twitter-user scraper. + - type: textarea + validations: + required: true + attributes: + label: Expected behavior + description: A brief description of what should happen. + - type: textarea + attributes: + label: Screenshots and recordings + description: | + If applicable, add screenshots or videos to help explain your problem. (Videos should be as short as possible! Avoid watermarks too.) + - type: input + validations: + required: true + attributes: + label: OS / Distro + description: Include the version too, please! + placeholder: e.g. Windows 10, Ubuntu 20.04, macOS 10.15... + - type: input + validations: + required: true + attributes: + label: Output from `snscrape --version` + - type: input + validations: + required: true + attributes: + label: Scraper + placeholder: e.g. twitter-user, reddit-search,... + - type: textarea + validations: + required: false + attributes: + label: Backtrace + description: What is the error snscrape gives you, if any? + - type: input + validations: + required: false + attributes: + label: Dump of locals + description: | + Here put a link to the dump of your snscrape locals, if it's a crash. (snscrape should tell you the path). + Please note that it may contain identifying info such as IP address, if the website returns that. + You can also optionally request to exchange the file in private. + Finally, if snscrape didn't crash, leave this field blank. + - type: dropdown + validations: + required: true + attributes: + label: How are you using snscrape? + options: ['CLI', 'Module'] + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. From afb6bfc429737ff8a7858e6089226edc148fbc78 Mon Sep 17 00:00:00 2001 From: TheTechRobo <52163910+TheTechRobo@users.noreply.github.com> Date: Tue, 4 Jan 2022 12:55:41 -0500 Subject: [PATCH 2/2] add feature_request and question templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.yml | 27 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 6 +++++ 3 files changed, 35 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ef602de..ad484ce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -57,13 +57,13 @@ body: attributes: label: Backtrace description: What is the error snscrape gives you, if any? - - type: input + - type: textarea validations: required: false attributes: label: Dump of locals description: | - Here put a link to the dump of your snscrape locals, if it's a crash. (snscrape should tell you the path). + Here attach the dump of your snscrape locals, if it's a crash. (snscrape should tell you the path). Please note that it may contain identifying info such as IP address, if the website returns that. You can also optionally request to exchange the file in private. Finally, if snscrape didn't crash, leave this field blank. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..5cf91e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,27 @@ +name: Feature Request +description: Want a feature? Ask; we don't bite! +labels: 'enhancement' +body: + - type: markdown + attributes: + value: | + ## Self Check + - Try searching existing GitHub Issues (open or closed) for similar issues. + - type: textarea + validations: + required: true + attributes: + label: Describe the feature + description: A clear description of what the feature is. + - type: textarea + validations: + required: false + attributes: + label: Would this fix a problem you're experiencing? If so, specify. + - type: textarea + attributes: + label: Did you consider other alternatives? + description: If so, specify + - type: input + attributes: + label: Additional context diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..e23dcd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,6 @@ +--- +name: Question +about: Ask away! +labels: 'question' + +---