From d11a39556b2ff4d94ac3c849946ef042747c4379 Mon Sep 17 00:00:00 2001 From: hayden Date: Tue, 6 Feb 2024 14:28:35 +0800 Subject: [PATCH] docs: add issue templates --- .github/ISSUE_TEMPLATE/1_bug_report.yaml | 67 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature_request.yaml | 28 ++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 19 ------ 3 files changed, 95 insertions(+), 19 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml new file mode 100644 index 0000000..e70e6a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -0,0 +1,67 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: input + id: version + attributes: + label: Version + description: Which version did the problem appear on? + placeholder: v0.0.1 + validations: + required: true + + - type: dropdown + id: sql-type + attributes: + label: Which SQL? + description: Which kind of SQL did the problem appear on? + options: + - MySQL + - Flink + - Spark + - Hive + - Postgre + - Trino + - Impala + - Any Others + validations: + required: true + + - type: textarea + id: sql-content + attributes: + label: SQL content + placeholder: SELECT * FROM table; + description: Please provide the minimal SQL text that reproduces the problem. + render: sql + + - type: textarea + id: js-code + attributes: + label: JavaScript/TypeScript code + description: Please provide the minimal demo code that reproduces the problem. + render: typescript + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yaml b/.github/ISSUE_TEMPLATE/2_feature_request.yaml new file mode 100644 index 0000000..f8e5da9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yaml @@ -0,0 +1,28 @@ +name: Feature Request +description: Suggest an idea for this project +title: '[Feature Request]: ' +labels: [] +body: + - type: markdown + attributes: + value: | + To help us efficiently reviewing your feature request, please fill out this form. + + - type: dropdown + id: sql-type + attributes: + label: Topic + options: + - Support new SQL + - Support new features on parser + - Enhance existing features + - Documents + - Any Others + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: Please describe your feature request. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index b0ec0f0..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- -**Version** -e.g. v3.0.5 - -**The Type of SQL** -e.g. SparkSQL | FlinkSQL | HiveSQL | Impala - -**Your Code** -e.g. parser.parserSql(....); - -**Problem** -e.g. the code do not work.