Commit ba424470

David Schnurr <schnerd@users.noreply.github.com>
2023-11-09 02:31:05
issue templates (#698)
* issue templates * Fix
1 parent 97810fc
.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,64 @@
+name: Bug report
+description: Report an issue or bug with this library
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is an issue with the Python library and not an underlying OpenAI API
+      description: Issues with the underlying OpenAI API should be reported on our [Developer Community](https://community.openai.com/c/api/7)
+      options:
+        - label: This is an issue with the Python library
+          required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is, and any additional context.
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Fetch a '...'
+        2. Update the '....'
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: code-snippets
+    attributes:
+      label: Code snippets
+      description: If applicable, add code snippets to help explain your problem.
+      render: Python
+    validations:
+      required: false
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: macOS
+    validations:
+      required: true
+  - type: input
+    id: language-version
+    attributes:
+      label: Python version
+      placeholder: Python v3.11.4
+    validations:
+      required: true
+  - type: input
+    id: lib-version
+    attributes:
+      label: Library version
+      placeholder: openai v1.0.1
+    validations:
+      required: true
.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,7 @@
+blank_issues_enabled: false
+contact_links:
+  - name: OpenAI support
+    url: https://help.openai.com/
+    about: |
+      Please only file issues here that you believe represent actual bugs or feature requests for the OpenAI Python library.
+      If you're having general trouble with the OpenAI API, please visit our help center to get support.
.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,28 @@
+name: Feature request
+description: Suggest an idea for this library
+labels: ['feature-request']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: checkboxes
+    id: non_api
+    attributes:
+      label: Confirm this is a feature request for the Python library and not the underlying OpenAI API.
+      description: Feature requests for the underlying OpenAI API should be reported on our [Developer Community](https://community.openai.com/c/api/7)
+      options:
+        - label: This is a feature request for the Python library
+          required: true
+  - type: textarea
+    id: feature
+    attributes:
+      label: Describe the feature or improvement you're requesting
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.
.github/pull_request_template.md
@@ -0,0 +1,10 @@
+<!-- Thank you for contributing to this project! -->
+<!-- The code in this repository is all auto-generated, and is not meant to be edited manually. -->
+<!-- We recommend opening an Issue instead, but you are still welcome to open a PR to share for -->
+<!-- an improvement if you wish, just note that we are unlikely to merge it as-is. -->
+
+- [ ] I understand that this repository is auto-generated and my pull request may not be merged
+
+## Changes being requested
+
+## Additional context & links