Skip to content

Commit

Permalink
Add issue templates
Browse files Browse the repository at this point in the history
(cherry picked from commit praw-dev/prawcore@c3da744)
  • Loading branch information
LilSpazJoekp committed Nov 26, 2023
1 parent 02335cd commit a35a7ff
Show file tree
Hide file tree
Showing 3 changed files with 120 additions and 0 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit a35a7ff

Please sign in to comment.