From a35a7ff873596901807dba8cd6bf1b3edb1c0834 Mon Sep 17 00:00:00 2001 From: LilSpazJoekp <15524072+LilSpazJoekp@users.noreply.github.com> Date: Sun, 8 Jan 2023 16:52:27 -0600 Subject: [PATCH] Add issue templates (cherry picked from commit praw-dev/prawcore@c3da7445b7e10c9dc8c789fd75d0110de522cd58) --- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 21 +++++ 3 files changed, 120 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 0000000..5ebf127 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +body: + - id: bug-description + attributes: + label: Describe the Bug + placeholder: A clear and concise description of what the bug is. + type: textarea + validations: + required: true + - id: desired-result + attributes: + label: Desired Result + placeholder: Describe the desired result. + type: textarea + validations: + required: true + - id: code + attributes: + description: | + Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) + code example here, without the Reddit() initialization, to not leak private credentials. + This will be automatically formatted into code, so no need for backticks. + label: Code to reproduce the bug + placeholder: Insert code here... + render: Python + type: textarea + validations: + required: true + - id: credential-check + attributes: + description: | + The `Reddit()` initialization in my code example does not include the following parameters to prevent credential leakage: + `client_secret`, `password`, or `refresh_token`. + label: My code does not include sensitive credentials + options: + - label: "Yes, I have removed sensitive credentials from my code." + required: true + type: checkboxes + - id: logs + attributes: + description: | + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + label: Relevant Logs + render: Shell + type: textarea + validations: + required: true + - id: previously-worked + attributes: + label: This code has previously worked as intended + multiple: false + options: + - "I'm not sure, I haven't used this code before." + - "Yes" + - "No" + type: dropdown + validations: + required: true + - id: environment + attributes: + description: What operating system, version, and/or environment are you working with? + label: Operating System/Environment + placeholder: "Example: macOS Sonoma 14.1.1" + type: input + validations: + required: true + - id: python-version + attributes: + description: | + What implementation and version of Python are you working with? + CPython is assumed unless indicated otherwise. + label: Python Version + placeholder: "Example: 3.12.0" + type: input + validations: + required: true + - id: asyncprawcore-version + attributes: + description: What version of `asyncprawcore` are you encountering this issue with? Obtain this by running `pip show asyncprawcore`. + label: asyncprawcore Version + type: input + validations: + required: true + - id: anything-else + attributes: + description: Anything that will give us more context about the issue you are encountering! + label: Links, references, and/or additional comments? + type: textarea +description: File a bug report +labels: [ "bug", "unverified" ] +name: Bug Report diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..df4b53c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: r/redditdev subreddit + about: For general help using PRAW, please ask here. + url: https://redditdev.reddit.com + - name: Official praw-dev Slack + about: For more real-time help, feel free to join our Slack. + url: https://join.slack.com/t/praw/shared_invite/enQtOTUwMDcxOTQ0NzY5LWVkMGQ3ZDk5YmQ5MDEwYTZmMmJkMTJkNjBkNTY3OTU0Y2E2NGRlY2ZhZTAzMWZmMWRiMTMwYjdjODkxOGYyZjY diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1214b4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,21 @@ +body: + - type: textarea + attributes: + label: Describe the solution you'd like + placeholder: A clear and concise description of what you want to happen. + id: feature-description + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: Clear and concise description of any alternative solutions or features you've considered. + id: alternatives-considered + - type: textarea + attributes: + label: Additional context + placeholder: Add any other context or links here. + id: additional-context +description: Suggest an idea for this project +labels: ["Feature Request"] +name: Feature Request