This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/rocketmq.git
The following commit(s) were added to refs/heads/develop by this push:
new 6f6032e9e [ISSUE #6673]Issue template enhancements (#6674)
6f6032e9e is described below
commit 6f6032e9eb812d42a67bea3cdb02cf4ef6e7f6c3
Author: mxsm <[email protected]>
AuthorDate: Thu May 4 18:53:41 2023 +0800
[ISSUE #6673]Issue template enhancements (#6674)
* [ISSUE #6673]Issue template enhancements
* optimize issue template
---
.github/ISSUE_TEMPLATE/bug_report.md | 44 ----------
.github/ISSUE_TEMPLATE/bug_report.yml | 113 +++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/enhancement_request.md | 33 --------
.github/ISSUE_TEMPLATE/enhancement_request.yml | 57 +++++++++++++
.github/ISSUE_TEMPLATE/feature_request.md | 23 -----
.github/ISSUE_TEMPLATE/feature_request.yml | 40 +++++++++
6 files changed, 210 insertions(+), 100 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md
b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 1264226c1..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,44 +0,0 @@
----
-name: Bug Report
-about: Create a report to help us identify any unintended flaws, errors, or
faults
-title: ''
-labels: type/bug
-assignees: ''
-
----
-### Before Creating the Bug Report
-
-- [ ] I found a bug, not just asking a question, which should be created in
[GitHub Discussions](https://github.com/apache/rocketmq/discussions).
-- [ ] I have searched the [GitHub
Issues](https://github.com/apache/rocketmq/issues) and [GitHub
Discussions](https://github.com/apache/rocketmq/discussions) of this
repository and believe that this is not a duplicate.
-- [ ] I have confirmed that this bug belongs to the current repository, not
other repositories of RocketMQ.
-
-### Describe the Bug
-
-<!-- A clear and concise description of what the bug is. -->
-
-### Steps to Reproduce
-
-<!-- If possible, provide a recipe for reproducing the error. -->
-
-### What Did You Expect to See?
-
-<!-- A clear and concise description of what you expected to see. -->
-
-### What Did You See Instead?
-
-<!-- A clear and concise description of what you saw instead. -->
-
-### What Version Are You Using?
-
-<!-- (e.g., `v5.0.0`, `f3e113c`, etc) -->
-
-### Environment
-
-<!-- Compiler: (e.g., "Oracle JDK 11.0.17")
-OS: (e.g., "Ubuntu 20.04")
-Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251")
-OS (if different from OS compiled on): (e.g., "Windows Server 2019") -->
-
-### 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 000000000..d46c3cd2a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,113 @@
+#
+# 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
+title: "[Bug] Bug title "
+description: Create a report to help us identify any unintended flaws, errors,
or faults.
+labels: [ "type/bug" ]
+body:
+ - type: checkboxes
+ attributes:
+ label: Before Creating the Bug Report
+ options:
+ - label: >
+ I found a bug, not just asking a question, which should be created
in [GitHub Discussions](https://github.com/apache/rocketmq/discussions).
+ required: true
+ - label: >
+ I have searched the [GitHub
Issues](https://github.com/apache/rocketmq/issues) and [GitHub
Discussions](https://github.com/apache/rocketmq/discussions) of this
repository and believe that this is not a duplicate.
+ required: true
+ - label: >
+ I have confirmed that this bug belongs to the current repository,
not other repositories of RocketMQ.
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Runtime platform environment
+ description: Describe the runtime platform environment.
+ placeholder: >
+ OS: (e.g., "Ubuntu 20.04")
+ OS: (e.g., "Windows Server 2019")
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: RocketMQ version
+ description: Describe the RocketMQ version.
+ placeholder: >
+ branch: (e.g develop|4.9.x)
+ version: (e.g. 5.1.0|4.9.5)
+ Git commit id: (e.g. c88b5cfa72e204962929eea105687647146112c6)
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: JDK Version
+ description: Run or Compiler version.
+ placeholder: >
+ Compiler: (e.g., "Oracle JDK 11.0.17")
+ OS: (e.g., "Ubuntu 20.04")
+ Runtime (if different from JDK above): (e.g., "Oracle JRE 8u251")
+ OS (if different from OS compiled on): (e.g., "Windows Server 2019")
+ validations:
+ required: false
+
+ - type: textarea
+ attributes:
+ label: Describe the Bug
+ description: Describe what happened.
+ placeholder: >
+ A clear and concise description of what the bug is.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Steps to Reproduce
+ description: Describe the steps to reproduce the bug here.
+ placeholder: >
+ If possible, provide a recipe for reproducing the error.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What Did You Expect to See?
+ description: You expect to see result.
+ placeholder: >
+ A clear and concise description of what you expected to see.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: What Did You See Instead?
+ description: You instead to see result.
+ placeholder: >
+ A clear and concise description of what you saw instead.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Additional Context
+ description: Additional context.
+ placeholder: >
+ Add any other context about the problem here.
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md
b/.github/ISSUE_TEMPLATE/enhancement_request.md
deleted file mode 100644
index 4603de1a2..000000000
--- a/.github/ISSUE_TEMPLATE/enhancement_request.md
+++ /dev/null
@@ -1,33 +0,0 @@
----
-name: Enhancement Request
-about: Suggest an enhancement for this project
-title: ''
-labels: type/enhancement
-assignees: ''
-
----
-### Before Creating the Enhancement Request
-
-<!-- Most of issues should be classified as bug or feature request. An issue
should be considered as an enhancement when it proposes improvements to
existing functionality or user experience, without necessarily introducing new
features or fixing existing bugs. -->
-
-- [ ] I have confirmed that this should be classified as an enhancement rather
than a bug/feature.
-
-### Summary
-
-<!-- A clear and concise description of the enhancement you would like to see
in the project. -->
-
-### Motivation
-
-<!-- Explain why you believe this enhancement is necessary, and how it
benefits the project and community. Include any specific use cases that you
have in mind. -->
-
-### Describe the Solution You'd Like
-
-<!-- Describe the enhancement you propose, detailing the change and
implementation steps involved. If you have multiple solutions, please list them
separately. -->
-
-### Describe Alternatives You've Considered
-
-<!-- List any alternative enhancements or implementations you have considered,
and explain why they may not be as effective or appropriate. -->
-
-### Additional Context
-
-<!-- Add any relevant context, screenshots, prototypes, or other supplementary
information to help illustrate the enhancement. -->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.yml
b/.github/ISSUE_TEMPLATE/enhancement_request.yml
new file mode 100644
index 000000000..0d15db864
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement_request.yml
@@ -0,0 +1,57 @@
+name: Enhancement Request
+title: "[Enhancement] Enhancement title"
+description: Suggest an enhancement for this project
+labels: [ "type/enhancement" ]
+body:
+ - type: checkboxes
+ attributes:
+ label: Before Creating the Enhancement Request
+ description: >
+ Most of issues should be classified as bug or feature request. An
issue should be considered as an enhancement when it proposes improvements to
+ existing functionality or user experience, without necessarily
introducing new features or fixing existing bugs.
+ options:
+ - label: >
+ I have confirmed that this should be classified as an enhancement
rather than a bug/feature.
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Summary
+ placeholder: >
+ A clear and concise description of the enhancement you would like to
see in the project.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Motivation
+ placeholder: >
+ Explain why you believe this enhancement is necessary, and how it
benefits the project and community.
+ Include any specific use cases that you have in mind.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe the Solution You'd Like
+ placeholder: >
+ Describe the enhancement you propose, detailing the change and
implementation steps involved.
+ If you have multiple solutions, please list them separately.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe Alternatives You've Considered
+ placeholder: >
+ List any alternative enhancements or implementations you have
considered, and explain why they may not be as effective or appropriate.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Additional Context
+ placeholder: >
+ Add any relevant context, screenshots, prototypes, or other
supplementary information to help illustrate the enhancement.
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md
b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index ed51a0b8b..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,23 +0,0 @@
----
-name: Feature Request
-about: Suggest an idea for this project
-title: ''
-labels: type/new feature
-assignees: ''
-
----
-### Is Your Feature Request Related to a Problem? Please Describe It
-
-<!-- A clear and concise description of what the problem is. -->
-
-### 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 000000000..c894e6d44
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,40 @@
+name: Feature Request
+title: "[Feature] New feature title"
+description: Suggest an idea for this project.
+labels: [ "type/new feature" ]
+body:
+ - type: textarea
+ attributes:
+ label: Is Your Feature Request Related to a Problem?
+ description: Please Describe It.
+ placeholder: >
+ A clear and concise description of what the problem is.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe the Solution You'd Like
+ description: Describe how you solved it.
+ placeholder: >
+ A clear and concise description of what you want to happen.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Describe Alternatives You've Considered
+ description: Describe your solution
+ placeholder: >
+ A clear and concise description of any alternative solutions or
features you've considered.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Additional Context
+ description: Additional context.
+ placeholder: >
+ Add any other context about the problem here.
+ validations:
+ required: false
