Bug report changes and new documentation issue template

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,84 +1,97 @@
 body:
-  - type: textarea
+  - id: bug-description
     attributes:
       label: Describe the Bug
       placeholder: A clear and concise description of what the bug is.
-    id: bug-description
+    type: textarea
     validations:
       required: true
-  - type: textarea
+  - id: desired-result
     attributes:
       label: Desired Result
       placeholder: Describe the desired result.
-    id: desired-result
+    type: textarea
     validations:
       required: true
-  - type: textarea
+  - id: code
     attributes:
-      description: Copy and paste any relevant log/stacktrace output.
-      label: Relevant Logs
-      render: shell
-    id: logs
-  - type: textarea
-    attributes:
-      description: Provide your [Minimal, Complete, and Verifiable](https://stackoverflow.com/help/mcve) code example here, without the Reddit() initialization, so as to not leak private credentials.
+      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
-    id: code
-  - type: dropdown
+      render: Python
+    type: textarea
+    validations:
+      required: true
+  - id: credential-check
     attributes:
-      label: My code example does not include the `Reddit()` initialization to prevent credential leakage.
+      label: |
+        The `Reddit()` initialization in my code example does not include the following parameters to prevent credential leakage: 
+        `client_secret`, `password`, or `refresh_token`.
       options:
-        - "Yes"
-    id: credential-check
+        - label: "Yes"
+          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
-  - type: dropdown
+  - id: previously-worked
     attributes:
       label: This code has previously worked as intended.
       multiple: false
       options:
+        - "Not sure, I haven't used this code before."
         - "Yes"
         - "No"
-    id: previously-worked
+    type: dropdown
     validations:
       required: true
-  - type: input
+  - id: environment
     attributes:
       description: What operating system, version, and environment are you working with.
       label: Operating System/Environment
-      placeholder: macOS Monterey 12.0.0
-    id: environment
+      placeholder: "Example: macOS Ventura 13.0.0"
+    type: input
     validations:
       required: true
-  - type: input
+  - id: python-version
     attributes:
-      description: What implementation and version of Python are you working with. CPython is assumed unless indicated otherwise.
+      description: |
+        What implementation and version of Python are you working with.
+        CPython is assumed unless indicated otherwise.
       label: Python Version
-      placeholder: Python 3.9.1
-    id: python-version
+      placeholder: "Example: 3.11.1"
+    type: input
     validations:
       required: true
-  - type: input
+  - id: praw-version
     attributes:
+      description: What version of PRAW. Obtain this by running `pip show praw`.
       label: PRAW Version
-      placeholder: 7.4.0
-    id: praw-version
+    type: input
     validations:
       required: true
-  - type: input
+  - id: prawcore-version
     attributes:
+      description: What version of Prawcore. Obtain this by running `pip show prawcore`.
       label: Prawcore Version
-      placeholder: 2.3.0
-    id: prawcore-version
+    type: input
     validations:
       required: true
-  - type: textarea
+  - id: anything-else
     attributes:
       description: Links or references? Anything that will give us more context about the issue you are encountering!
       label: Anything else?
-    id: anything-else
+    type: textarea
 description: File a bug report
-labels: ["bug", "unverified"]
+labels: [ "bug", "unverified" ]
 name: Bug Report

.github/ISSUE_TEMPLATE/documentation_issue.yml

@@ -0,0 +1,62 @@
+body:
+  - id: documentation-error
+    attributes:
+      description: A description of the documentation issue you have found.
+      label: Describe the Documentation Issue
+    type: textarea
+    validations:
+      required: true
+  - id: attribute-check
+    attributes:
+      description: |
+        This issue is **NOT** related to missing or extraneous attributes in the class's 'Typical Attributes' section.
+        See [Determine Available Attributes of an Object](https://praw.readthedocs.io/en/stable/getting_started/quick_start.html#determine-available-attributes-of-an-object) for more information.
+        Otherwise, you are more than welcome to open a pull request to address the attribute in question.
+      label: Attributes
+      options:
+        - label: "Yes"
+          required: true
+    type: checkboxes
+  - id: location
+    attributes:
+      description: Provide the documentation URL or file path of the documentation where the issue can be found.
+      label: Location of the issue
+    type: input
+    validations:
+      required: true
+  - id: expected-result
+    attributes:
+      description: Describe what you expected to see in the documentation.
+      label: What did you expect to see?
+    type: textarea
+    validations:
+      required: true
+  - id: actual-result
+    attributes:
+      description: Describe what you actually saw in the documentation.
+      label: What did you actually see?
+    type: textarea
+    validations:
+      required: true
+  - id: proposed-fix
+    attributes:
+      description: If you have a suggestion for how to fix the documentation error, please describe it here.
+      label: Proposed Fix
+    type: textarea
+  - id: environment
+    attributes:
+      description: If this issue is a rendering error, what operating system and web browser are you using when viewing the documentation?
+      label: Operating System/Web Browser
+      placeholder: "Example: macOS Monterey, Google Chrome 89.0.4389.82"
+    type: input
+  - id: anything-else
+    attributes:
+      description: Links or references? Anything that will give us more context about the documentation error you are encountering!
+      label: Anything else?
+    type: textarea
+  - type: markdown
+    attributes:
+      value: Please attach a screenshot of the documentation error if possible after submitting the issue.
+description: Report a documentation error
+labels: [ "documentation", "unverified" ]
+name: Documentation Error Report