From 87b377d89a32e06b9be82cedce861e5850c59179 Mon Sep 17 00:00:00 2001 From: Adam J Esslinger Date: Thu, 3 Sep 2026 08:39:41 -0400 Subject: [PATCH] docs: add Issue Form templates for migration flow Add three GitHub Issue Form templates under .github/ISSUE_TEMPLATE/ that the Tabularis builtin-to-plugin migration flow pre-fills via query params keyed on each form element's id: - migration-failure.yml: filed when switching a connection from the builtin postgres driver to this plugin fails (failure_mode dropdown, version/OS/error fields, labels: migration) - capability-gap.yml: filed when a connection uses a builtin-only feature the plugin doesn't yet cover (labels: capability-gap) - bug_report.yml: general bug report from the standing 'Report a plugin issue' link in Settings (labels: bug) Verified against the official schemastore Issue Forms JSON schema (all three valid), with unique underscore-legal ids per form, markdown elements carrying no id, and the referenced labels (migration, capability-gap, bug) all present on the repo. Closes #56 --- .github/ISSUE_TEMPLATE/bug_report.yml | 44 +++++++++++++ .github/ISSUE_TEMPLATE/capability-gap.yml | 40 ++++++++++++ .github/ISSUE_TEMPLATE/migration-failure.yml | 67 ++++++++++++++++++++ 3 files changed, 151 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/capability-gap.yml create mode 100644 .github/ISSUE_TEMPLATE/migration-failure.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..f540a8a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,44 @@ +name: Bug report +description: Report a problem with the PostgreSQL plugin. +title: "Bug: " +labels: ["bug"] +body: + - type: input + id: plugin_version + attributes: + label: Plugin version + validations: + required: true + - type: input + id: app_version + attributes: + label: Tabularis app version + validations: + required: true + - type: input + id: os + attributes: + label: Operating system + placeholder: e.g. macOS 15.1, Windows 11, Ubuntu 24.04 + validations: + required: true + - type: textarea + id: description + attributes: + label: What happened? + description: What did you expect, and what happened instead? + validations: + required: true + - type: textarea + id: repro_steps + attributes: + label: Steps to reproduce + validations: + required: false + - type: textarea + id: error + attributes: + label: Error message, if any + render: text + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/capability-gap.yml b/.github/ISSUE_TEMPLATE/capability-gap.yml new file mode 100644 index 0000000..740b58b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/capability-gap.yml @@ -0,0 +1,40 @@ +name: Feature parity gap +description: >- + Filed automatically by Tabularis when a connection uses a builtin-only + feature this plugin doesn't yet support. +title: "Feature parity gap: " +labels: ["capability-gap"] +body: + - type: markdown + attributes: + value: | + This form was pre-filled by Tabularis's builtin-to-plugin migration + flow, from a connection that uses a feature the plugin's declared + capabilities don't yet cover. Review before submitting — nothing has + been sent yet. No credentials or connection strings are included. + - type: input + id: feature + attributes: + label: Missing feature + placeholder: e.g. SSH tunneling, IAM auth, Kubernetes port-forwarding + validations: + required: true + - type: input + id: plugin_version + attributes: + label: Plugin version + validations: + required: true + - type: input + id: app_version + attributes: + label: Tabularis app version + validations: + required: true + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Anything else that might help scope or reproduce this. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/migration-failure.yml b/.github/ISSUE_TEMPLATE/migration-failure.yml new file mode 100644 index 0000000..b1cf6d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/migration-failure.yml @@ -0,0 +1,67 @@ +name: Migration from builtin failed +description: >- + Filed automatically by Tabularis when switching a connection from the + builtin postgres driver to this plugin fails. +title: "Migration failed: " +labels: ["migration"] +body: + - type: markdown + attributes: + value: | + This form was pre-filled by Tabularis's builtin-to-plugin migration + flow. Review the details below before submitting — nothing has been + sent yet. No credentials or connection strings are included. + - type: dropdown + id: failure_mode + attributes: + label: Failure mode + description: >- + "Process" means the plugin itself never started (interpreter + missing, crash). "Connection" means the plugin started fine but + the specific database connection failed. + options: + - connection + - process + validations: + required: true + - type: input + id: plugin_version + attributes: + label: Plugin version + validations: + required: true + - type: input + id: app_version + attributes: + label: Tabularis app version + validations: + required: true + - type: input + id: os + attributes: + label: Operating system + placeholder: e.g. macOS 15.1, Windows 11, Ubuntu 24.04 + validations: + required: true + - type: input + id: migrated_from_driver + attributes: + label: Migrated from + placeholder: e.g. builtin postgres + validations: + required: false + - type: textarea + id: error + attributes: + label: Error message + description: The exact error returned when the migration or connection failed. + render: text + validations: + required: true + - type: textarea + id: additional_context + attributes: + label: Additional context + description: Anything else that might help reproduce or diagnose this. + validations: + required: false