[ISSUE #4491]🔨Revise issue templates for bug reports, documentation, feature requests, and unit tests to enhance clarity and usability (#4492)

Author: mxsm

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -16,96 +16,66 @@
 #
 
 name: Bug Report
-title: "[Bug🐛] Bug title "
-description: Create a report to help us identify any unintended flaws, errors, or faults.
+title: "[Bug🐛] "
+description: Report a bug to help us improve
 labels: [ "bug🐛" ]
 body:
   - type: checkboxes
     attributes:
-      label: Before Creating the Bug Report
+      label: Prerequisites
       options:
-        - label: >
-            I found a bug, not just asking a question, which should be created in [GitHub Discussions](https://github.com/mxsm/rocketmq-rust/discussions).
+        - label: I have searched existing issues and discussions
           required: true
-        - label: >
-            I have searched the [GitHub Issues](https://github.com/mxsm/rocketmq-rust/issues) and [GitHub Discussions](https://github.com/mxsm/rocketmq-rust/discussions)  of this repository and believe that this is not a duplicate.
+        - label: This is a bug, not a question (use Discussions for questions)
           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: false
-
-  - type: textarea
-    attributes:
-      label: RocketMQ Rust version
-      description: Describe the RocketMQ Rust version.
-      placeholder: >
-        branch: (e.g master)
-        version: (e.g. 0.1.0)
-        Git commit id: (e.g. 37b9bfa7f4516b8da69e91ec0cb288b9724262a2)
-    validations:
-      required: false
 
   - type: textarea
     attributes:
-      label: Rust Version
-      description: Run or Compiler version.
-      placeholder: >
-        Compiler: (e.g., "1.75.0")
-        OS: (e.g., "Ubuntu 20.04")
+      label: Environment
+      description: Your runtime environment
+      placeholder: |
+        - OS: Ubuntu 22.04 / Windows 11 / macOS 14
+        - RocketMQ Rust: v0.3.0 / main branch / commit abc123
+        - Rust: 1.75.0
+      value: |
+        - OS: 
+        - RocketMQ Rust: 
+        - Rust: 
     validations:
-      required: false
+      required: true
 
   - type: textarea
     attributes:
-      label: Describe the Bug
-      description: Describe what happened.
-      placeholder: >
-        A clear and concise description of what the bug is.
+      label: Bug Description
+      description: What happened?
+      placeholder: Clear and concise description of the bug
     validations:
-      required: false
+      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.
+      placeholder: |
+        1. Start broker with config...
+        2. Send message with...
+        3. Observe error...
     validations:
-      required: false
+      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: false
+      label: Expected vs Actual
+      placeholder: |
+        **Expected:** Should send successfully
+        **Actual:** Connection timeout error
 
   - 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: false
+      label: Logs/Screenshots
+      description: Relevant logs, error messages, or screenshots
 
   - type: textarea
     attributes:
       label: Additional Context
-      description: Additional context.
-      placeholder: >
-        Add any other context about the problem here.
-    validations:
-      required: false
+      description: Additional context
+      placeholder: Add any other context about the problem here

.github/ISSUE_TEMPLATE/doc.yml

@@ -15,41 +15,58 @@
 # limitations under the License.
 #
 
-name: Documentation Related
-title: "[Doc📝] Documentation Related "
-description: I find some issues related to the documentation.
+name: Documentation
+title: "[Doc📝] "
+description: Report documentation issues or improvements
 labels: [ "documentation📝" ]
 body:
-  - type: checkboxes
+  - type: dropdown
+    id: issue-type
     attributes:
-      label: Search before creation
-      description: >
-        Please make sure to search in the [issues](https://github.com/mxsm/rocketmq-rust/issues)
-        first to see whether the same issue was reported already.
+      label: Issue Type
+      description: Select the type of documentation issue
       options:
-        - label: >
-            I had searched in the [issues](https://github.com/mxsm/rocketmq-rust/issues) and found
-            no similar issues.
-          required: true
+        - Typo/Grammar
+        - Missing documentation
+        - Incorrect/Outdated information
+        - Improvement suggestion
+    validations:
+      required: true
 
   - type: textarea
     attributes:
-      label: Documentation Related
-      description: Describe the suggestion about document.
-      placeholder: >
-        e.g There is a typo
+      label: Location
+      description: Where is the issue?
+      placeholder: |
+        File: README.md line 42
+        Or: https://docs.rs/rocketmq-rust/...
     validations:
-      required: false
+      required: true
 
-  - type: checkboxes
+  - type: textarea
     attributes:
-      label: Are you willing to submit PR?
-      description: >
-        This is absolutely not required, but we are happy to guide you in the contribution process
-        especially if you already have a good understanding of how to implement the fix.
-      options:
-        - label: Yes I am willing to submit a PR!
+      label: Description
+      description: What needs to be fixed or improved?
+      placeholder: The example code is outdated and doesn't compile
+    validations:
+      required: true
 
-  - type: markdown
+  - type: textarea
     attributes:
-      value: "Thanks for completing our form!"
+      label: Suggested Fix
+      description: How should it be corrected?
+      placeholder: |
+        Change:
+        ```rust
+        // old code
+        ```
+        To:
+        ```rust
+        // new code
+        ```
+
+  - type: checkboxes
+    attributes:
+      label: Willing to contribute?
+      options:
+        - label: I can submit a PR for this

.github/ISSUE_TEMPLATE/enhancement_request.yml

@@ -1,75 +1,2 @@
-#
-# 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: Enhancement Request
-title: "[Enhancement⚡️] Enhancement title"
-description: Suggest an enhancement for this project
-labels: [ "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: false
-
-  - type: textarea
-    attributes:
-      label: Summary
-      placeholder: >
-        A clear and concise description of the enhancement you would like to see in the project.
-    validations:
-      required: false
-
-  - 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: false
-
-  - 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: false
-
-  - 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: false
-
-  - 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
+# This template has been merged into feature_request.yml
+# Please use Feature/Enhancement Request template instead

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -16,43 +16,51 @@
 #
 
 
-name: Feature Request
-title: "[Feature🚀] New feature title"
-description: Suggest an idea for this project.
+name: Feature/Enhancement Request
+title: "[Feature🚀] "
+description: Suggest a new feature or improvement
 labels: [ "feature🚀" ]
 body:
-  - type: textarea
+  - type: dropdown
+    id: type
     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.
+      label: Type
+      description: Choose the type of request
+      options:
+        - New Feature
+        - Enhancement (improvement to existing functionality)
     validations:
-      required: false
+      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.
+      label: Problem/Motivation
+      description: What problem does this solve? Why is it needed?
+      placeholder: Currently, users cannot...
     validations:
-      required: false
+      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.
+      label: Proposed Solution
+      description: How would you implement this?
+      placeholder: |
+        Add a new API that allows...
+        
+        Example:
+        ```rust
+        let producer = Producer::new();
+        ```
     validations:
-      required: false
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: Other approaches you've considered
+      placeholder: Could also use... but that has limitations...
 
   - type: textarea
     attributes:
       label: Additional Context
-      description: Additional context.
-      placeholder: >
-        Add any other context about the problem here.
-    validations:
-      required: false
+      description: Links, references, or examples