From d2d99df6a345dfcd751709af436501d9acc6dbc9 Mon Sep 17 00:00:00 2001 From: Alejandro Do Nascimento Mora Date: Thu, 31 Oct 2024 12:25:35 +0100 Subject: [PATCH] chore: add github issue template --- .github/CODEOWNERS | 1 - .github/ISSUE_TEMPLATE/bug_report.yml | 114 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.yml | 52 ++++++++++ 4 files changed, 171 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index ba9ebc0..1c50734 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1 @@ * @timescale/ts-vector -/.github/ @jgpruitt @cevian @avthars \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..e7465c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,114 @@ +--- +name: ๐Ÿ› Bug report +description: Is something not working? Let's fix it together! +title: "[Bug]: " +labels: ["bug", "triage", "community", "pgvectorscale"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: | + Tell us what happened and also what you would have expected to + happen instead. + placeholder: "Describe the bug" + validations: + required: true + + - type: input + id: pgvectorscale-extension-version + attributes: + label: pgvectorscale extension affected + description: | + Let us know what version of the pgvectorscale postgres extension you + are running. + placeholder: "0.4.0" + validations: + required: false + + - type: input + id: postgresql-version + attributes: + label: PostgreSQL version used + description: Let us know what version of PostgreSQL you are running. + placeholder: "14.1" + validations: + required: true + + - type: input + id: os + attributes: + label: What operating system did you use? + description: | + Please provide OS, version, and architecture. For example: + Windows 10 x64, Ubuntu 21.04 x64, Mac OS X 10.5 ARM, Rasperry + Pi i386, etc. + placeholder: "Ubuntu 21.04 x64" + validations: + required: true + + - type: dropdown + id: installation + attributes: + label: What installation method did you use? + multiple: true + options: + - Docker + - Source + - Pypi + - Other (Please specify in the description of the bug) + - Not applicable + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: What platform did you run on? + multiple: true + options: + - Amazon Web Services (AWS) + - Google Cloud Platform (GCP) + - Managed Service for TimescaleDB (MST/Aiven) + - Microsoft Azure Cloud + - On prem/Self-hosted + - Timescale Cloud + - Other + - Not applicable + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output and stack trace + description: | + Please copy and paste any relevant log output or a stack + trace. This will be automatically formatted into code, so no + need for backticks. + render: bash + + - type: textarea + id: reproduce + attributes: + label: How can we reproduce the bug? + description: | + Please try to provide step-by-step instructions how to + reproduce the issue. If possible, provide scripts that we can + run to trigger the bug. + render: bash + validations: + required: true + - type: dropdown + id: work-on-it + attributes: + label: Are you going to work on the bugfix? + description: No pressure at all, but weโ€™re ready to help you navigate the contribution process. + options: + - "๐Ÿฆธ Yes , I will submit a PR soon!" + - "๐Ÿ†˜ No, could someone else please work on the bugfix?" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..cceaefc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: pgai discord + url: https://discord.com/channels/1246241636019605616/1246243698111676447 + about: Get free help from the pgai community diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..506fd87 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,52 @@ +--- +name: ๐Ÿ’ก Feature request +description: Suggest a new feature +title: "[Feature]: <Feature name>" +labels: ["feature-request", "community", "pgvectorscale"] +body: + - type: markdown + id: info + attributes: + value: | + Only use this template to suggest a new feature that doesn't already + exist, or enhancements to existing features. For bugs, use the bug + report template. + + - type: textarea + id: what + attributes: + label: What problem does the new feature solve? + description: | + Describe the problem and why it is important to solve. Did you consider + alternative solutions, perhaps outside the pgvectorscale? Why is it + better to add the feature to pgvectorscale? + validations: + required: true + + - type: textarea + id: how + attributes: + label: What does the feature do? + description: | + Give a high-level overview of what the feature does and how it would + work. + validations: + required: true + + - type: textarea + id: implementation + attributes: + label: Implementation challenges + description: | + If you have ideas of how to implement the feature, and any particularly + challenging issues to overcome, then provide them here. + validations: + required: false + - type: dropdown + id: work-on-it + attributes: + label: Are you going to work on this feature? + description: No pressure at all, but weโ€™re ready to help you navigate the contribution process. + options: + - "๐Ÿฆธ Yes , I will submit a PR soon!" + - "๐Ÿ†˜ No, could someone else please consider working on it?"