diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml new file mode 100644 index 0000000000..5158494d6f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -0,0 +1,97 @@ +name: Bug report +description: Something in OpenBot does not work the way it should. +title: "🐛 Bug: " +body: + - type: markdown + attributes: + value: | + Thanks for reporting this. Please search the [open issues](https://github.com/CopilotKit/OpenBot/issues) first in case it is already known. + + If this is a security problem, do not open a public issue. [Report it privately](https://github.com/CopilotKit/OpenBot/security/advisories/new) instead. + + - type: textarea + id: what-happened + attributes: + label: What happened + description: What you saw, including any error message. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: The shortest steps that make it happen. Include the Bot and channel if they matter. + value: | + 1. + 2. + 3. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: What you expected + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: The release you installed, the image tag you run, or the commit you built from (`git rev-parse --short HEAD`). + placeholder: v0.2.0 + validations: + required: true + + - type: dropdown + id: install + attributes: + label: How you run OpenBot + options: + - Desktop app + - Published container image (ghcr.io/copilotkit/openbot) + - Helm chart + - From a clone (Quick start) + - Other + validations: + required: true + + - type: dropdown + id: surface + attributes: + label: Where it happens + multiple: true + options: + - Web app + - Desktop app + - Android app + - iOS app + - Slack + - Microsoft Teams + - Server or API only + + - type: dropdown + id: intelligence + attributes: + label: CopilotKit Intelligence + description: Where the deployment's Intelligence runs. Threads and memory live there, so it matters for those bugs. + options: + - Managed (copilotkit.ai) + - Local, on this machine + - Self-hosted + - Not sure + + - type: input + id: environment + attributes: + label: Operating system and browser + placeholder: macOS 26.1, Chrome 141 + + - type: textarea + id: logs + attributes: + label: Logs + description: Server, worker or browser console output around the failure. Remove keys, tokens and personal data before pasting. + render: shell diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml new file mode 100644 index 0000000000..cbca987039 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -0,0 +1,37 @@ +name: Feature request +description: Suggest something OpenBot should do. +title: "🚀 Feature Request: " +body: + - type: markdown + attributes: + value: | + Thanks for the idea. Please search the [open issues](https://github.com/CopilotKit/OpenBot/issues) first in case it has already been suggested. + + - type: textarea + id: problem + attributes: + label: The problem + description: What you are trying to do, and what stops you today. + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: What you would like + description: How it could work. Say which part of OpenBot it touches if you know, for example the gateway, a channel or the app. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives you considered + description: Workarounds you use now, or other ways to solve it. + + - type: checkboxes + id: contribute + attributes: + label: Contributing + options: + - label: I would like to work on this. diff --git a/.github/ISSUE_TEMPLATE/3-documentation.yml b/.github/ISSUE_TEMPLATE/3-documentation.yml new file mode 100644 index 0000000000..14a2831807 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-documentation.yml @@ -0,0 +1,17 @@ +name: Documentation +description: Something in the README or docs is wrong, unclear or missing. +title: "📚 Documentation: " +body: + - type: input + id: page + attributes: + label: Page + description: A link to the page or the file path, for example `docs/deployment.md`. + + - type: textarea + id: problem + attributes: + label: What is wrong or missing + description: Quote the passage if it is wrong, and say what it should say if you know. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..8f01a11e43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Report a security problem + url: https://github.com/CopilotKit/OpenBot/security/advisories/new + about: Report it privately instead of in a public issue. + - name: Documentation + url: https://github.com/CopilotKit/OpenBot/tree/main/docs + about: Setup, configuration, deployment and architecture.