docs: add issue templates
This commit is contained in:
parent
337885be8b
commit
d11a39556b
67
.github/ISSUE_TEMPLATE/1_bug_report.yaml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/1_bug_report.yaml
vendored
Normal file
@ -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
|
||||
|
28
.github/ISSUE_TEMPLATE/2_feature_request.yaml
vendored
Normal file
28
.github/ISSUE_TEMPLATE/2_feature_request.yaml
vendored
Normal file
@ -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.
|
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
19
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -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.
|
Loading…
Reference in New Issue
Block a user