diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.md b/.github/ISSUE_TEMPLATE/1-bug_report.md deleted file mode 100644 index 57ccd493b..000000000 --- a/.github/ISSUE_TEMPLATE/1-bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Report a bug or unexpected behavior -title: '' -labels: bug -assignees: '' ---- - -## Description - -Is this reporting a bug or feature request? - -If reporting a bug, please fill out the following: - -### Environment - -- pipecat-ai version: -- python version: -- OS: - -### Issue description - -Provide a clear description of the issue. - -### Repro steps - -List the steps to reproduce the issue. - -### Expected behavior - -### Actual behavior - -### Logs diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml new file mode 100644 index 000000000..653214e24 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -0,0 +1,87 @@ +name: Bug report +description: Report a bug or unexpected behavior +type: Bug +body: + - type: markdown + attributes: + value: | + ## Bug Report + + Thank you for taking the time to fill out this bug report. + + - type: markdown + attributes: + value: | + ### Environment + + - type: input + id: pipecat-version + attributes: + label: pipecat version + description: Which version are you using? + placeholder: e.g., 0.0.63 + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python version + description: Which Python version are you using? + placeholder: e.g., 3.12.8 + validations: + required: true + + - type: input + id: os + attributes: + label: Operating System + description: Which OS are you using? + placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5 + validations: + required: true + + - type: textarea + id: description + attributes: + label: Issue description + description: Provide a clear description of the issue. + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: List the steps to reproduce the issue. + placeholder: | + 1. Do this... + 2. Then do that... + 3. Observe the error... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Logs + description: If applicable, include any relevant logs or error messages + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-question.md b/.github/ISSUE_TEMPLATE/2-question.md deleted file mode 100644 index ff0913903..000000000 --- a/.github/ISSUE_TEMPLATE/2-question.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Question -about: Ask a question or get help -title: '' -labels: question -assignees: '' ---- - -## Environment (if applicable) - -- pipecat-ai version: -- python version: -- OS: - -## Question - -Provide your question in detail here. - -## What I've tried - -Describe what you've already tried or research you've done. - -## Context - -Any additional context or information that might help others understand your question better. diff --git a/.github/ISSUE_TEMPLATE/2-question.yml b/.github/ISSUE_TEMPLATE/2-question.yml new file mode 100644 index 000000000..fab8a82d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-question.yml @@ -0,0 +1,67 @@ +name: Question +description: Ask a question or get help +type: Question +body: + - type: markdown + attributes: + value: | + ## Question + + Use this form to ask a question about pipecat. + + - type: markdown + attributes: + value: | + ### Environment (if applicable) + + - type: input + id: pipecat-version + attributes: + label: pipecat version + description: Which version are you using? (if applicable) + placeholder: e.g., 0.0.63 + validations: + required: false + + - type: input + id: python-version + attributes: + label: Python version + description: Which Python version are you using? (if applicable) + placeholder: e.g., 3.12.8 + validations: + required: false + + - type: input + id: os + attributes: + label: Operating System + description: Which OS are you using? (if applicable) + placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5 + validations: + required: false + + - type: textarea + id: question + attributes: + label: Question + description: Provide your question in detail here. + validations: + required: true + + - type: textarea + id: tried + attributes: + label: What I've tried + description: Describe what you've already tried or research you've done. + placeholder: I've looked at the documentation and tried... + validations: + required: false + + - type: textarea + id: context + attributes: + label: Context + description: Any additional context or information that might help others understand your question better. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/3-feature_request.md b/.github/ISSUE_TEMPLATE/3-feature_request.md deleted file mode 100644 index fff5404bb..000000000 --- a/.github/ISSUE_TEMPLATE/3-feature_request.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -name: Feature request -about: Suggest an enhancement or new feature -title: '' -labels: enhancement -assignees: '' ---- - -## Problem Statement - -A clear description of the problem this feature would solve. For example: "I'm always frustrated when..." - -## Proposed Solution - -A clear and concise description of what you want to happen. - -## Alternative Solutions - -Any alternative solutions or features you've considered. - -## Additional Context - -Add any other context, mockups, or screenshots about the feature request here. - -## Would you be willing to help implement this feature? - -- [ ] Yes, I'd like to contribute -- [ ] No, I'm just suggesting diff --git a/.github/ISSUE_TEMPLATE/3-feature_request.yml b/.github/ISSUE_TEMPLATE/3-feature_request.yml new file mode 100644 index 000000000..88069737c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-feature_request.yml @@ -0,0 +1,52 @@ +name: Feature request +description: Suggest an enhancement or new feature +type: Enhancement +body: + - type: markdown + attributes: + value: | + ## Feature Request + + Thank you for suggesting an enhancement to pipecat. + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: A clear description of the problem this feature would solve. + placeholder: I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternative Solutions + description: Any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: Add any other context, mockups, or screenshots about the feature request here. + placeholder: You can drag and drop images here to include them. + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Would you be willing to help implement this feature? + options: + - label: Yes, I'd like to contribute + - label: No, I'm just suggesting diff --git a/.github/ISSUE_TEMPLATE/4-service-issue.yml b/.github/ISSUE_TEMPLATE/4-service-issue.yml new file mode 100644 index 000000000..f366f0e69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-service-issue.yml @@ -0,0 +1,82 @@ +name: Service Issue +description: An issue with a third-party service +type: Service Issue +body: + - type: markdown + attributes: + value: | + ## Service Issue + + Use this form to report an issue with a third-party service integration. + + - type: input + id: pipecat-version + attributes: + label: pipecat version + description: Which version are you using? + placeholder: e.g., 0.0.63 + validations: + required: true + + - type: input + id: service-name + attributes: + label: Service Name + description: Which third-party service is having issues? + placeholder: e.g., OpenAI, ElevenLabs, Anthropic + validations: + required: true + + - type: input + id: service-version + attributes: + label: Service or model version + description: Which version of the service API or model are you using? + placeholder: e.g., v1, gpt-4.1 + validations: + required: false + + - type: textarea + id: description + attributes: + label: Issue Description + description: Provide a clear description of the service issue. + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: Provide steps to reproduce the issue. + placeholder: | + 1. Configure service X + 2. Call method Y + 3. See error Z + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Error Logs + description: If available, include any error messages or logs. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/5-new-service.yml b/.github/ISSUE_TEMPLATE/5-new-service.yml new file mode 100644 index 000000000..35784da79 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5-new-service.yml @@ -0,0 +1,56 @@ +name: New Service +description: Request to support a new third-party service +type: New Service +body: + - type: markdown + attributes: + value: | + ## New Service Request + + Use this form to request support for a new third-party service in pipecat. + + - type: input + id: service-name + attributes: + label: Service Name + description: What is the name of the third-party service? + placeholder: e.g., NewAPI, SomeService + validations: + required: true + + - type: input + id: service-website + attributes: + label: Service Website + description: Link to the service's website or documentation + placeholder: e.g., https://newapi.com + validations: + required: true + + - type: textarea + id: service-description + attributes: + label: Service Description + description: Briefly describe what this service does and how it works. + validations: + required: true + + - type: textarea + id: api-info + attributes: + label: API Information + description: If available, provide details about the service's API. + placeholder: | + - API documentation link + - Authentication method + - Key endpoints you'd like supported + validations: + required: false + + - type: checkboxes + id: contribution + attributes: + label: Would you be willing to help implement this service? + options: + - label: Yes, I'd like to contribute + - label: No, I'm just suggesting diff --git a/.github/ISSUE_TEMPLATE/6-dependency.yml b/.github/ISSUE_TEMPLATE/6-dependency.yml new file mode 100644 index 000000000..eef1db072 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/6-dependency.yml @@ -0,0 +1,74 @@ +name: Dependency Issue +description: An issue with a Pipecat dependency (not a third-party service) +type: Dependency Issue +body: + - type: markdown + attributes: + value: | + ## Dependency Issue + + Use this form to report an issue with a Pipecat dependency. + + - type: input + id: pipecat-version + attributes: + label: pipecat version + description: Which version are you using? + placeholder: e.g., 0.0.63 + validations: + required: true + + - type: input + id: dependency-name + attributes: + label: Dependency Name + description: Which Pipecat dependency is causing the issue? + placeholder: e.g., openai, anthropic, fastapi + validations: + required: true + + - type: input + id: dependency-version + attributes: + label: Dependency Version + description: Which version of the dependency are you using? + placeholder: e.g., 1.2.3 + validations: + required: true + + - type: textarea + id: description + attributes: + label: Issue Description + description: Provide a clear description of the dependency issue. + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Impact + description: How is this dependency issue affecting your usage of pipecat? + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: If applicable, provide steps to reproduce the issue. + placeholder: | + 1. Install dependency X + 2. Run command Y + 3. See error Z + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Error Logs + description: If applicable, include any relevant error messages or logs. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/7-troubleshooting.yml b/.github/ISSUE_TEMPLATE/7-troubleshooting.yml new file mode 100644 index 000000000..b8d626c5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/7-troubleshooting.yml @@ -0,0 +1,70 @@ +name: Troubleshooting +description: Help with a specific use case +type: Troubleshooting +body: + - type: markdown + attributes: + value: | + ## Troubleshooting Request + + Use this form to get help with a specific use case or implementation. + + - type: input + id: pipecat-version + attributes: + label: pipecat version + description: Which version are you using? + placeholder: e.g., 0.0.63 + validations: + required: true + + - type: input + id: python-version + attributes: + label: Python version + description: Which version of Python are you using? + placeholder: e.g., 3.12.8 + validations: + required: true + + - type: input + id: os + attributes: + label: Operating System + description: Which OS are you using? + placeholder: e.g., Ubuntu 24.04, Windows 11, macOS 12.5 + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case Description + description: Describe what you're trying to accomplish with pipecat. + validations: + required: true + + - type: textarea + id: current-approach + attributes: + label: Current Approach + description: What have you tried so far? Include code snippets if relevant. + render: python + validations: + required: true + + - type: textarea + id: errors + attributes: + label: Errors or Unexpected Behavior + description: Describe any errors or unexpected behavior you're encountering. + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other information that might help us understand your situation. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 824f5a0da..3ba13e0ce 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1 @@ -blank_issues_enabled: true -contact_links: - - name: Documentation - url: https://docs.pipecat.ai/getting-started/overview - about: Please check our documentation before creating an issue. - - name: Discord - url: https://discord.gg/pipecat - about: You can ask questions and get help in our Discord community. +blank_issues_enabled: false