diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..2d671c9984 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,129 @@ +name: Bug report +description: Report a reproducible problem with the Supabase CLI. +title: "" +labels: + - 🐛 Bug +body: + - type: markdown + attributes: + value: | + Thanks for helping improve the Supabase CLI. Please include the exact command and output whenever possible so maintainers can reproduce the issue quickly. + + - type: dropdown + id: affected-area + attributes: + label: Affected area + description: Pick the area that best matches the failing command or workflow. + options: + - Auth + - Database + - Edge Functions + - Migrations + - Storage + - Local development + - Docker + - Seeding + - Realtime + - Installation + - Other + validations: + required: true + + - type: input + id: cli-version + attributes: + label: Supabase CLI version + description: Run `supabase --version`. + placeholder: v2.23.4 + validations: + required: true + + - type: input + id: os + attributes: + label: Operating system + placeholder: macOS 15.5, Ubuntu 24.04, Windows 11, etc. + validations: + required: true + + - type: dropdown + id: install-method + attributes: + label: Installation method + options: + - brew + - bun + - npm + - pnpm + - yarn + - Docker image + - GitHub release binary + - Other + validations: + required: false + + - type: textarea + id: command + attributes: + label: Command + description: Paste the exact command you ran. + render: shell + placeholder: supabase db push + validations: + required: true + + - type: textarea + id: actual-output + attributes: + label: Actual output + description: Paste the full error, log output, or terminal output. Remove secrets before submitting. + render: shell + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: What did you expect the CLI to do instead? + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Include the smallest project, config, schema, or command sequence that reproduces the problem. + placeholder: | + 1. Run `supabase init` + 2. Configure ... + 3. Run ... + 4. See ... + validations: + required: true + + - type: input + id: ticket-id + attributes: + label: Debug ticket ID + description: If possible, rerun the failing command with `--create-ticket` and paste the ticket ID. + placeholder: ab1ac733e31e4f928a4d7c8402543712 + validations: + required: false + + - type: textarea + id: docker-services + attributes: + label: Docker and service versions + description: For local development issues, include `docker version` and `supabase services` output. + render: shell + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add screenshots, links, package versions, browser details, or anything else that helps explain the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 7dca709d76..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**System information** -Rerun the failing command with `--create-ticket` flag. - - Ticket ID: [e.g. ab1ac733e31e4f928a4d7c8402543712] - - Version of OS: [e.g. Ubuntu 22.04] - - Version of CLI: [e.g. v1.60.0] - - Version of Docker: [e.g. v25.0.3] - - Versions of services: [output from `supabase services` command] - -**Additional context** -If applicable, add any other context about the problem here. - - Browser [e.g. chrome, safari] - - Version of supabase-js [e.g. v2.22.0] - - Version of Node.js [e.g. v16.20.0] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..8c49825527 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Supabase support + url: https://supabase.com/support + about: Get help with your Supabase project, account, billing, or hosted services. + - name: Supabase documentation + url: https://supabase.com/docs/reference/cli + about: Read the Supabase CLI command reference and guides. diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 0000000000..05db1554ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,52 @@ +name: Documentation +description: Suggest an improvement to Supabase CLI documentation. +title: "" +labels: + - 📘 Docs +body: + - type: input + id: link + attributes: + label: Documentation link + description: Link to the page, section, README, or command reference that needs improvement. + placeholder: https://supabase.com/docs/reference/cli/... + validations: + required: false + + - type: dropdown + id: issue-type + attributes: + label: Issue type + options: + - Missing documentation + - Incorrect documentation + - Confusing documentation + - Outdated documentation + - Typo or formatting + - Other + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem + description: What is missing, incorrect, confusing, or outdated? + validations: + required: true + + - type: textarea + id: improvement + attributes: + label: Suggested improvement + description: Describe the change you would like to see. + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add screenshots, examples, related issues, or command output if relevant. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..4eb1c65734 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,65 @@ +name: Feature request +description: Suggest an improvement or new capability for the Supabase CLI. +title: "" +labels: + - ✨ Feature +body: + - type: checkboxes + id: existing-issues + attributes: + label: Existing issues + description: Please search existing issues before opening a new request. + options: + - label: I have searched the existing issues. + required: false + + - type: dropdown + id: affected-area + attributes: + label: Affected area + options: + - Auth + - Database + - Edge Functions + - Migrations + - Storage + - Local development + - Docker + - Seeding + - Realtime + - Installation + - Other + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem to solve + description: What workflow is difficult, missing, or confusing today? + validations: + required: true + + - type: textarea + id: proposed-solution + attributes: + label: Proposed solution + description: Describe the CLI behavior, command, flag, output, or workflow you would like to see. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Describe workarounds or other designs you have considered. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add links, examples, screenshots, or related issues. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d61..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/improve-documentation.md b/.github/ISSUE_TEMPLATE/improve-documentation.md deleted file mode 100644 index 24e3b0ab38..0000000000 --- a/.github/ISSUE_TEMPLATE/improve-documentation.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Improve documentation -about: Suggest an improvement to our documentation -title: '' -labels: '' -assignees: '' - ---- - -**Link** -Add a link to the page which needs improvement (if relevant) - -**Describe the problem** -Is the documentation missing? Or is it confusing? Why is it confusing? - -**Describe the improvement** -A clear and concise description of the improvement. - -**Additional context** -Add any other context or screenshots that help clarify your question.