optimize issue template (#872)

feat: add issue templates for bug reports, feature requests, questions, proposals, and discussions
3 months ago · c4c82f79bd
--- a/.github/ISSUE_TEMPLATE/#0_bug_report_zh.yml
+++ b/.github/ISSUE_TEMPLATE/#0_bug_report_zh.yml
@@ -0,0 +1,122 @@
 name: "🐞 Bug 报告"
 description: "提交 Bug 帮助我们改进"
 title: "[BUG] "
 labels: ["bug"]
 body:
  - type: markdown
    attributes:
      value: |
        ## 👋 感谢您的反馈！
        
        请填写以下信息帮助我们更好地理解和解决问题。

  - type: checkboxes
    id: duplicate-check
    attributes:
      label: "✅ 验证清单"
      description: "请确认您已经完成以下操作："
      options:
        - label: "🔍 我已经搜索过 [现有 Issues](https://github.com/apache/incubator-seata-go/issues)，确信这不是重复问题"
          required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🔧 环境信息

  - type: input
    id: go-version
    attributes:
      label: "🚀 Go 版本"
      description: "请提供您使用的 Go 版本"
      placeholder: "例如：1.23.0"
    validations:
      required: true

  - type: input
    id: seata-go-version
    attributes:
      label: "📦 Seata-go 版本"
      description: "请提供您使用的 seata-go 版本"
      placeholder: "例如：v1.2.0"
    validations:
      required: true

  - type: dropdown
    id: platform
    attributes:
      label: "💾 操作系统"
      description: "您使用的操作系统平台"
      options:
        - "🪟 Windows"
        - "🍎 macOS"
        - "🐧 Linux"
    validations:
      required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🐛 问题详情

  - type: textarea
    id: bug-description
    attributes:
      label: "📝 Bug 描述"
      description: "请清晰简洁地描述您遇到的问题"
      placeholder: |
        请详细描述您遇到的 bug，包括：
        • 具体的问题现象
        • 错误信息（如有）
        • 影响范围
    validations:
      required: true

  - type: textarea
    id: reproduction-steps
    attributes:
      label: "🔄 重现步骤"
      description: "请提供详细的步骤来重现这个问题"
      placeholder: |
        请按顺序列出重现步骤：
        1. 第一步...
        2. 第二步...
        3. 第三步...
        4. 看到错误

        💡 如果可能，请提供 GitHub 仓库链接或最小重现代码
    validations:
      required: true

  - type: textarea
    id: expected-behavior
    attributes:
      label: "✅ 预期行为"
      description: "请描述您期望应该发生什么"
      placeholder: "详细描述正确的行为应该是什么样的..."
    validations:
      required: true

  - type: textarea
    id: actual-behavior
    attributes:
      label: "❌ 实际行为"
      description: "请描述实际发生了什么"
      placeholder: |
        详细描述实际发生的情况，包括：
        • 错误消息
        • 异常堆栈
        • 日志输出
    validations:
      required: true

  - type: textarea
    id: possible-solution
    attributes:
      label: "💡 可能的解决方案"
      description: "如果您对解决这个问题有想法，请在此分享"
      placeholder: "分享您的想法、建议或已尝试的解决方案..."
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/#1_feature_request_zh.yml
+++ b/.github/ISSUE_TEMPLATE/#1_feature_request_zh.yml
@@ -0,0 +1,94 @@
 name: "✨ 功能请求"
 description: "提出新想法或功能建议"
 title: "[FEATURE] "
 labels: ["enhancement"]
 body:
  - type: markdown
    attributes:
      value: |
        ## 🚀 功能请求
        
        感谢您为项目提供新的想法和建议！

  - type: checkboxes
    id: verification
    attributes:
      label: "✅ 验证清单"
      description: "请确认您已经完成以下操作："
      options:
        - label: "🔍 我已经搜索过 [现有 Issues](https://github.com/apache/incubator-seata-go/issues)，确信这不是重复请求"
          required: true
        - label: "📋 我已经查看了 [发布说明](https://github.com/apache/incubator-seata-go/releases)，确信此功能尚未实现"
          required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 💡 功能详情

  - type: textarea
    id: solution-description
    attributes:
      label: "🎯 功能描述"
      description: "清晰概述您建议的功能或方法"
      placeholder: |
        请详细描述您希望看到的功能，包括：
        • 功能的核心作用
        • 预期的使用方式
        • 与现有功能的关系
    validations:
      required: true

  - type: textarea
    id: use-cases
    attributes:
      label: "📋 使用场景"
      description: "这个功能适用的典型场景和业务价值"
      placeholder: |
        请描述具体的使用场景：
        • 在什么情况下会使用这个功能？
        • 解决了什么具体问题？
        • 带来什么价值？
    validations:
      required: true

  - type: textarea
    id: complexity-risks
    attributes:
      label: "⚖️ 复杂性与风险评估"
      description: "潜在的技术挑战、实现难度或可能的风险"
      placeholder: |
        请考虑并描述：
        • 实现难度评估
        • 可能的技术挑战
        • 对现有功能的影响
        • 性能考虑
    validations:
      required: false

  - type: textarea
    id: external-dependencies
    attributes:
      label: "🔗 外部依赖"
      description: "实现此功能需要的第三方工具、服务或集成"
      placeholder: |
        列出所需的外部依赖：
        • 第三方库或框架
        • 外部服务
        • 特定的环境要求
    validations:
      required: false

  - type: textarea
    id: additional-context
    attributes:
      label: "📚 附加信息"
      description: "任何其他相关的上下文、截图或参考资料"
      placeholder: |
        提供任何有助于理解需求的信息：
        • 相关文档或标准
        • 参考实现
        • 设计草图或截图
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/#2_question_zh.yml
+++ b/.github/ISSUE_TEMPLATE/#2_question_zh.yml
@@ -0,0 +1,80 @@
 name: "❓ 问题咨询"
 description: "提出关于项目的疑问"
 title: "[QUESTION] "
 labels: ["question"]
 body:
  - type: markdown
    attributes:
      value: |
        ## 🤔 问题咨询
        
        我们很乐意帮助您解答关于 Seata-go 的问题！

  - type: checkboxes
    id: verification
    attributes:
      label: "✅ 验证清单"
      description: "请确认您已经完成以下操作："
      options:
        - label: "🔍 我已经搜索过 [现有 Issues](https://github.com/apache/incubator-seata-go/issues)，确信这不是重复问题"
          required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🔧 环境信息（可选）

  - type: input
    id: seata-go-version
    attributes:
      label: "📦 Seata-go 版本"
      description: "请提供您使用的 seata-go 版本"
      placeholder: "例如：v1.2.0"
    validations:
      required: false

  - type: markdown
    attributes:
      value: |
        ---
        ## ❓ 问题详情

  - type: textarea
    id: question
    attributes:
      label: "💬 您的问题"
      description: "请详细描述您想了解的问题"
      placeholder: |
        请详细描述您的问题，包括：
        • 具体想了解什么？
        • 遇到了什么困惑？
        • 期望得到什么样的帮助？
    validations:
      required: true

  - type: textarea
    id: context
    attributes:
      label: "📚 背景信息"
      description: "添加任何可能帮助我们回答您问题的上下文"
      placeholder: |
        提供相关背景信息：
        • 您在做什么项目？
        • 为什么需要了解这个问题？
        • 您已经尝试过什么？
    validations:
      required: false

  - type: textarea
    id: related-resources
    attributes:
      label: "🔗 相关资源"
      description: "链接到任何相关文档、代码或资源"
      placeholder: |
        分享相关链接或资源：
        • 相关文档链接
        • 代码仓库或片段
        • 参考资料
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/#3_proposal_zh.yml
+++ b/.github/ISSUE_TEMPLATE/#3_proposal_zh.yml
@@ -0,0 +1,47 @@
 name: "📝 提案"
 description: "创建一个技术提案"
 title: "[提案] "
 labels: ["proposal"]
 body:
  - type: checkboxes
    id: verification
    attributes:
      label: "⚠️ 验证"
      description: "请确认您已经完成以下操作："
      options:
        - label: 我已经搜索过 [issues](https://github.com/apache/incubator-seata-go/issues)，确信这不是一个重复的提案。
          required: true

  - type: markdown
    attributes:
      value: |
        ## 📋 提案详情
        请使用此模板提交具体的功能设计提案。
        如果您只想请求新功能并讨论可能的业务价值，请创建功能请求。

  - type: textarea
    id: proposal-summary
    attributes:
      label: "✨ 提案摘要"
      description: "您提案的简要概述"
      placeholder: "提供您的技术提案的简明摘要"
    validations:
      required: true

  - type: textarea
    id: implementation-approach
    attributes:
      label: "🛠️ 实现方法"
      description: "应该如何实现这个提案？"
      placeholder: "描述实现此提案的方法"
    validations:
      required: true

  - type: textarea
    id: additional-context
    attributes:
      label: "📚 附加上下文"
      description: "任何其他相关信息"
      placeholder: "提供可能有助于理解您提案的任何其他上下文"
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/#4_discussion_zh.yml
+++ b/.github/ISSUE_TEMPLATE/#4_discussion_zh.yml
@@ -0,0 +1,26 @@
 name: "💬 讨论"
 description: "开始一个关于项目的讨论"
 title: "[讨论] "
 labels: ["discussion"]
 body:
  - type: markdown
    attributes:
      value: "## 🔄 讨论主题"
      
  - type: textarea
    id: discussion-content
    attributes:
      label: "讨论详情"
      description: "请描述您想要讨论的内容"
      placeholder: "提供关于您想讨论的项目相关事项的详细信息"
    validations:
      required: true

  - type: textarea
    id: related-context
    attributes:
      label: "📚 相关背景"
      description: "添加任何相关的上下文或背景信息"
      placeholder: "分享有助于理解此讨论的背景信息"
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/0_bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/0_bug_report.yml
@@ -0,0 +1,122 @@
 name: "🐞 Bug Report"
 description: "Report a bug to help us improve"
 title: "[BUG] "
 labels: ["bug"]
 body:
  - type: markdown
    attributes:
      value: |
        ## 👋 Thank you for your feedback!
        
        Please fill out the following information to help us understand and resolve the issue.

  - type: checkboxes
    id: duplicate-check
    attributes:
      label: "✅ Verification Checklist"
      description: "Please verify that you've completed the following:"
      options:
        - label: "🔍 I have searched the [existing issues](https://github.com/apache/incubator-seata-go/issues) and confirmed this is not a duplicate"
          required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🔧 Environment Information

  - type: input
    id: go-version
    attributes:
      label: "🚀 Go Version"
      description: "The version of Go you're using"
      placeholder: "e.g., 1.23.0"
    validations:
      required: true

  - type: input
    id: seata-go-version
    attributes:
      label: "📦 Seata-go Version"
      description: "The version of seata-go you're using"
      placeholder: "e.g: v1.2.0"
    validations:
      required: true

  - type: dropdown
    id: platform
    attributes:
      label: "💾 Operating System"
      description: "What platform are you using?"
      options:
        - "🪟 Windows"
        - "🍎 macOS"
        - "🐧 Linux"
    validations:
      required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🐛 Issue Details

  - type: textarea
    id: bug-description
    attributes:
      label: "📝 Bug Description"
      description: "A clear and concise description of what the bug is"
      placeholder: |
        Please describe the bug in detail, including:
        • Specific problem symptoms
        • Error messages (if any)
        • Impact scope
    validations:
      required: true

  - type: textarea
    id: reproduction-steps
    attributes:
      label: "🔄 Steps to Reproduce"
      description: "Please provide detailed steps to reproduce this issue"
      placeholder: |
        Please list the steps to reproduce:
        1. First step...
        2. Second step...
        3. Third step...
        4. See error

        💡 If possible, please provide a GitHub repository link or minimal reproduction code
    validations:
      required: true

  - type: textarea
    id: expected-behavior
    attributes:
      label: "✅ Expected Behavior"
      description: "What did you expect to happen?"
      placeholder: "Describe in detail what the correct behavior should be..."
    validations:
      required: true

  - type: textarea
    id: actual-behavior
    attributes:
      label: "❌ Actual Behavior"
      description: "What actually happened?"
      placeholder: |
        Describe what actually happened, including:
        • Error messages
        • Exception stack traces
        • Log output
    validations:
      required: true

  - type: textarea
    id: possible-solution
    attributes:
      label: "💡 Possible Solution"
      description: "If you have ideas on how to fix this issue, please share them here"
      placeholder: "Share your thoughts, suggestions, or attempted solutions..."
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/1_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/1_feature_request.yml
@@ -0,0 +1,60 @@
 name: "✨ Feature Request"
 description: "Suggest an idea for this project"
 title: "[FEATURE] "
 labels: ["enhancement"]
 body:
  - type: checkboxes
    id: verification
    attributes:
      label: "⚠️ Verification"
      description: "Please verify that you've done the following:"
      options:
        - label: I have searched the [issues](https://github.com/apache/incubator-seata-go/issues) of this repository and believe that this is not a duplicate.
          required: true
        - label: I have searched the [release notes](https://github.com/apache/incubator-seata-go/releases) of this repository and believe that this is not a duplicate.
          required: true

  - type: textarea
    id: solution-description
    attributes:
      label: "🎯 Solution Description"
      description: "A clear overview of the proposed approach or feature."
      placeholder: "Describe the solution you'd like to see implemented"
    validations:
      required: true

  - type: textarea
    id: use-cases
    attributes:
      label: "📋 Use Cases"
      description: "Typical scenarios where this solution would be applied."
      placeholder: "Describe situations where this feature would be useful"
    validations:
      required: true

  - type: textarea
    id: complexity-risks
    attributes:
      label: "⚖️ Complexity & Risks"
      description: "Potential challenges, technical hurdles, or downsides."
      placeholder: "Describe any potential challenges or concerns"
    validations:
      required: false

  - type: textarea
    id: external-dependencies
    attributes:
      label: "🔗 External Dependencies"
      description: "Required third-party tools, services, or integrations."
      placeholder: "List any external tools or services needed"
    validations:
      required: false

  - type: textarea
    id: additional-context
    attributes:
      label: "📘 Additional Context"
      description: "Add any other context or screenshots about the feature request here."
      placeholder: "Add any other relevant information here"
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/2_question.yml
+++ b/.github/ISSUE_TEMPLATE/2_question.yml
@@ -0,0 +1,80 @@
 name: "❓ Question"
 description: "Ask a question about the project"
 title: "[QUESTION] "
 labels: ["question"]
 body:
  - type: markdown
    attributes:
      value: |
        ## 🤔 Question
        
        We're happy to help answer your questions about Seata-go!

  - type: checkboxes
    id: verification
    attributes:
      label: "✅ Verification Checklist"
      description: "Please verify that you've completed the following:"
      options:
        - label: "🔍 I have searched the [existing issues](https://github.com/apache/incubator-seata-go/issues) and confirmed this is not a duplicate"
          required: true

  - type: markdown
    attributes:
      value: |
        ---
        ## 🔧 Configuration (Optional)"

  - type: input
    id: seata-go-version
    attributes:
      label: "📦 Seata-go Version"
      description: "The version of seata-go you're using"
      placeholder: "e.g: v1.2.0"
    validations:
      required: false

  - type: markdown
    attributes:
      value: |
        ---
        ## ❓ Question Details

  - type: textarea
    id: question
    attributes:
      label: "💬 Your Question"
      description: "Please describe your question in detail"
      placeholder: |
        Please describe your question in detail, including:
        • What specifically would you like to know?
        • What confusion have you encountered?
        • What kind of help are you expecting?
    validations:
      required: true

  - type: textarea
    id: context
    attributes:
      label: "📚 Background Information"
      description: "Add any context that might help us answer your question"
      placeholder: |
        Provide relevant background information:
        • What project are you working on?
        • Why do you need to understand this?
        • What have you already tried?
    validations:
      required: false

  - type: textarea
    id: related-resources
    attributes:
      label: "🔗 Related Resources"
      description: "Link to any related documents, code, or resources"
      placeholder: |
        Share related links or resources:
        • Relevant documentation links
        • Code repositories or snippets
        • Reference materials
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/3_proposal.yml
+++ b/.github/ISSUE_TEMPLATE/3_proposal.yml
@@ -0,0 +1,47 @@
 name: "📝 Proposal"
 description: "Create a technical proposal"
 title: "[PROPOSAL] "
 labels: ["proposal"]
 body:
  - type: checkboxes
    id: verification
    attributes:
      label: "⚠️ Verification"
      description: "Please verify that you've done the following:"
      options:
        - label: I have searched the [issues](https://github.com/apache/incubator-seata-go/issues) of this repository and believe that this is not a duplicate.
          required: true

  - type: markdown
    attributes:
      value: |
        ## 📋 Proposal Details
        Please use this for a concrete design proposal for functionality.
        If you just want to request a new feature and discuss the possible business value, create a Feature Request instead.

  - type: textarea
    id: proposal-summary
    attributes:
      label: "✨ Proposal Summary"
      description: "A brief overview of your proposal"
      placeholder: "Provide a concise summary of your technical proposal"
    validations:
      required: true

  - type: textarea
    id: implementation-approach
    attributes:
      label: "🛠️ Implementation Approach"
      description: "How should this be implemented?"
      placeholder: "Describe the approach to implementing this proposal"
    validations:
      required: true

  - type: textarea
    id: additional-context
    attributes:
      label: "📚 Additional Context"
      description: "Any other relevant information"
      placeholder: "Provide any other context that might help understand your proposal"
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/4_discussion.yml
+++ b/.github/ISSUE_TEMPLATE/4_discussion.yml
@@ -0,0 +1,26 @@
 name: "💬 Discussion"
 description: "Start a discussion about the project"
 title: "[DISCUSSION] "
 labels: ["discussion"]
 body:
  - type: markdown
    attributes:
      value: "## 🔄 Discussion Topic"
      
  - type: textarea
    id: discussion-content
    attributes:
      label: "Discussion Details"
      description: "Please describe what you'd like to discuss"
      placeholder: "Provide details about what you want to discuss regarding the project"
    validations:
      required: true

  - type: textarea
    id: related-context
    attributes:
      label: "📚 Related Context"
      description: "Add any relevant context or background information"
      placeholder: "Share any background information that helps frame this discussion"
    validations:
      required: false
--- a/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md
@@ -1,19 +0,0 @@
 ---
 name: Bug Report
 about: Report a bug
 labels: kind/bug

 ---

 <!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!

 -->


 **What happened**:

 **What you expected to happen**:

 **How to reproduce it (as minimally and precisely as possible)**:

 **Anything else we need to know?**:
--- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
@@ -1,12 +0,0 @@
 ---
 name: Feature Request
 about: Suggest an idea for seata-go
 labels: kind/feature

 ---

 <!-- Please only use this template for submitting enhancement requests -->

 **What would you like to be added**:

 **Why is this needed**: