From 70a301b56409689388ba725edcd7a17bace34e7a Mon Sep 17 00:00:00 2001
From: Aaron Ai <yangkun.ayk@gmail.com>
Date: Wed, 26 Apr 2023 09:39:51 +0800
Subject: [PATCH] Add enhancement template

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 34 +++++++++----------
 .github/ISSUE_TEMPLATE/enhancement_request.md | 33 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 17 +++++-----
 .github/PULL_REQUEST_TEMPLATE.md              | 10 +++---
 4 files changed, 62 insertions(+), 32 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/enhancement_request.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index b87193188fe4..1264226c145f 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,44 +1,44 @@
 ---
 name: Bug Report
-about: Create a report to help us improve
+about: Create a report to help us identify any unintended flaws, errors, or faults
 title: ''
 labels: type/bug
 assignees: ''
 
 ---
-### Before creating the bug report
+### 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 confirm that this bug belongs to the current repository, not other repositories of RocketMQ.
+- [ ] I have confirmed that this bug belongs to the current repository, not other repositories of RocketMQ.
 
-### Describe the bug
+### Describe the Bug
 
-A clear and concise description of what the bug is.
+<!-- A clear and concise description of what the bug is. -->
 
-### Steps to reproduce
+### Steps to Reproduce
 
-If possible, provide a recipe for reproducing the error.
+<!-- If possible, provide a recipe for reproducing the error. -->
 
-### What did you expect to see?
+### What Did You Expect to See?
 
-A clear and concise description of what you expected to see.
+<!-- A clear and concise description of what you expected to see. -->
 
-### What did you see instead?
+### What Did You See Instead?
 
-A clear and concise description of what you saw instead.
+<!-- A clear and concise description of what you saw instead. -->
 
-### What version are you using?
+### What Version Are You Using?
 
-(e.g., `v5.0.0`, `f3e113c`, etc)
+<!-- (e.g., `v5.0.0`, `f3e113c`, etc) -->
 
 ### Environment
 
-Compiler: (e.g., "Oracle JDK 11.0.17")
+<!-- 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")
+OS (if different from OS compiled on): (e.g., "Windows Server 2019") -->
 
-### Additional context
+### Additional Context
 
-Add any other context about the problem here.
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md
new file mode 100644
index 000000000000..49c5058a7d6c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/enhancement_request.md
@@ -0,0 +1,33 @@
+---
+name: Enhancement Request
+about: Suggest an improvement for this project
+title: ''
+labels: type/enhancement
+assignees: ''
+
+---
+### Before Creating the Enhancement 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 improvement 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index a201924bb779..ed51a0b8ba17 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,19 +6,18 @@ labels: type/new feature
 assignees: ''
 
 ---
+### Is Your Feature Request Related to a Problem? Please Describe It
 
-### Is your feature request related to a problem? Please describe
+<!-- A clear and concise description of what the problem is. -->
 
-A clear and concise description of what the problem is.
+### Describe the Solution You'd Like
 
-### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
 
-A clear and concise description of what you want to happen.
+### Describe Alternatives You've Considered
 
-### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-A clear and concise description of any alternative solutions or features you've considered.
+### Additional Context
 
-### Additional context
-
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index f47f872851d0..18ca770718d1 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,15 @@
-### Make sure the target branch is right
-
-In most case, the target branch should be `develop`.
+<!-- Please make sure the target branch is right. In most case, the target branch should be `develop`. -->
 
 ### Which issue(s) this PR fixes
 
-Please ensure that the related issue has already been created, and [link this pull request to that issue using keywords](<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>) to ensure automatic closure.
+<!-- Please ensure that the related issue has already been created, and [link this pull request to that issue using keywords](<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>) to ensure automatic closure. -->
 
 Fixes #issue_id
 
 ### Brief description
 
-Write a brief description for your pull request to help the maintainer understand the reasons behind your changes.
+<!-- Write a brief description for your pull request to help the maintainer understand the reasons behind your changes. -->
 
 ### How did you test this change?
 
-In order to ensure the code quality of Apache RocketMQ, we expect every pull request to have undergone thorough testing.
+<!-- In order to ensure the code quality of Apache RocketMQ, we expect every pull request to have undergone thorough testing. -->