From 963d2841484a332157a8da60655b2d014da56285 Mon Sep 17 00:00:00 2001 From: Harmon Date: Fri, 23 Jun 2023 16:27:25 -0500 Subject: [PATCH] Add GitHub issue forms and template chooser --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++++ 3 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..639edea6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +name: Bug Report +description: Report broken or incorrect behavior. +labels: "Unconfirmed Bug" +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out a bug report. + Please note that this is only for reporting issues with the library. + If you need help using the library, start a [discussion](https://github.com/tweepy/tweepy/discussions) or join the [official Discord server](https://discord.gg/bJvqnhg) instead. + - type: input + attributes: + label: Summary + description: Provide a simple summary of your bug report. + validations: + required: true + - type: textarea + attributes: + label: Reproduction Steps + description: Explain what you did for the bug to happen. + validations: + required: true + - type: textarea + attributes: + label: Minimal Reproducible Example + description: This should be code, in the form of a [MRE](https://en.wikipedia.org/wiki/Minimal_reproducible_example), that demonstrates the bug. + render: python + - type: textarea + attributes: + label: Expected Results + description: What did you expect to happen? + validations: + required: true + - type: textarea + attributes: + label: Actual Results + description: What actually happened? + validations: + required: true + - type: input + attributes: + label: Twitter API Access Plan + description: | + What Twitter API access level / plan / tier do you have? + You can find this information in the Developer Portal. + placeholder: This is probably Free, Basic, Pro, or Enterprise. + validations: + required: true + - type: input + attributes: + label: Tweepy Version + description: | + What version of Tweepy are you using? + If you installed Tweepy using pip, you can use `pip show tweepy` to find this information. + validations: + required: true + - type: checkboxes + attributes: + label: Checklist + options: + - label: I have searched for duplicate issues. + required: true + - label: If applicable, I have shown the entire traceback. + - label: If applicable, I have removed any visible credentials from my code and/or screenshots. + - type: textarea + attributes: + label: Additional Context + description: If you have anything else to add, please do so here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..bd9f85f3b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Ask a question + url: https://github.com/tweepy/tweepy/discussions + about: Ask questions and discuss with other users of the library. + - name: Discord Server + url: https://discord.gg/bJvqnhg + about: Use the official Discord server to ask for help as well. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..1860b48f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: Suggest a feature for the library. +labels: Feature Request +body: + - type: input + attributes: + label: Summary + description: Provide a short summary of your feature request. + validations: + required: true + - type: textarea + attributes: + label: The Problem + description: | + What problem is your feature request trying to solve? + What becomes easier or possible if this feature is implemented? + validations: + required: true + - type: textarea + attributes: + label: The Ideal Solution + description: | + What is your ideal solution to the problem? + What would you like this feature to do? + validations: + required: true + - type: textarea + attributes: + label: The Current Solution + description: What is the current solution to the problem, if any? + - type: textarea + attributes: + label: Additional Context + description: If you have anything else to add, please do so here.