This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new fd579587fb improve issue template (#8056)
fd579587fb is described below
commit fd579587fb189a86bf39f5e12271c9e393052929
Author: labuladong <[email protected]>
AuthorDate: Sat Nov 19 19:20:02 2022 +0800
improve issue template (#8056)
---
.github/ISSUE_TEMPLATE/bug_report.md | 31 -----------
.github/ISSUE_TEMPLATE/bug_report.yml | 85 ++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 17 ------
.github/ISSUE_TEMPLATE/feature_request.yml | 66 +++++++++++++++++++++++
4 files changed, 151 insertions(+), 48 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 6bf71aa335..0000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-**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.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml
b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..5614507a02
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,85 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: Bug report
+description: Create a report to help us improve
+title: "[Bug] "
+labels: [ "type/bug" ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you very much for your feedback!
+
+ For suggestions or help, please consider:
+ 1. [User Mail List](mailto:[email protected])
([subscribe](mailto:[email protected]));
+ 2. [Github Discussion](https://github.com/apache/iotdb/discussions).
+
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: >
+ Please search [issues](https://github.com/apache/iotdb/issues) to
check if your issue has already been reported.
+ options:
+ - label: >
+ I searched in the [issues](https://github.com/apache/iotdb/issues)
and found nothing similar.
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Version
+ description: >
+ Please provide the OS and IoTDB version you are using. If you are
using the master branch, please provide the commit id.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe the bug and provide the minimal reproduce step
+ description: >
+ Screenshots and reproducing steps help to locate of the problem
quickly.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What did you expect to see?
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What did you see instead?
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ description: >
+ Add any other context about the problem here.
+ label: Anything else?
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ description: >
+ We look forward to the community of developers or users helping solve
IoTDB problems together. If you are willing to submit a PR to fix this problem,
please check the box.
+ options:
+ - label: I'm willing to submit a PR!
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 066b2d920a..0000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-**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/feature_request.yml
b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 0000000000..8ebfa38903
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,66 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature request] "
+labels: [ "type/feature-request" ]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thank you very much for your enhancement!
+
+ - type: checkboxes
+ attributes:
+ label: Search before asking
+ description: >
+ Please search [issues](https://github.com/apache/iotdb/issues) to
check if your issue has already been reported.
+ options:
+ - label: >
+ I searched in the [issues](https://github.com/apache/iotdb/issues)
and found nothing similar.
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Motivation
+ description: Describe the motivations for this enhancement. Ex. I'm
always frustrated when [...]
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Solution
+ description: Describe the proposed solution and add related materials
like links if any.
+
+ - type: textarea
+ attributes:
+ label: Alternatives
+ description: Describe other alternative solutions or features you
considered.
+
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit a PR?
+ description: >
+ We look forward to the community of developers or users helping solve
IoTDB problems together. If you are willing to submit a PR to implement the
enhancement, please check the box.
+ options:
+ - label: I'm willing to submit a PR!
+
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
\ No newline at end of file
