Refine PR and ISSUE templates for both languages

Signed-off-by: Dongjianwei001 <dongjianwei1@huawei.com>
2026-07-01 10:05:26 -04:00 · 2025-12-31 01:03:04 -08:00
parent b8261230b7
commit 42c313e496
5 changed files with 47 additions and 77 deletions
@@ -8,23 +8,18 @@ body:
    attributes:
      label: Checklist
      options:
-        - label: 1. 我已经搜索过相关问题，但没有得到预期的帮助. (https://gitcode.com/openHiTLS/openhitls/issues)
-        - label: 2. 最新版本中该错误尚未修复.
-        - label: 3. 请注意，如果您提交的Bug描述缺少相应的环境信息和最小可复现的demo，我们将很难复现和解决该问题，从而降低收到反馈的可能性，甚至该问题将被关闭.
+        - label: 1. I have searched existing issues. (https://gitcode.com/openHiTLS/openhitls/issues)
+        - label: 2. The bug exists in the latest version.
+        - label: 3. I understand that issues without environment info and minimal reproducible example may be closed.
    validations:
      required: true
  - type: textarea
    attributes:
-      label: 🐞 问题详细描述
-      description: |
-        请提供关于错误是什么的清晰而简洁的描述。
-
-
-        请添加一个最简洁的示例，以便我们通过运行代码重现错误。代码片段尽可能简洁（最小化）非常重要，因此请花时间精简任何不相关的代码，以帮助我们高效调试。您的示例应完全独立，并且不依赖于任何需要下载的构件。**否则，该问题将被关闭** 
-
-        请粘贴或描述您观察到的结果，如果您发现错误，请粘贴错误消息，包括异常的**完整**栈信息，将错误信息包含在```` ```triple quotes blocks``` ````内.
+      label: 🐞 Bug Description
+      description: >
+        Describe the bug and provide a minimal reproducible example if possible.
      placeholder: |
-        对 bug 的清晰、简洁的描述.
+        A clear and concise description of the bug.

            ```python
            # Sample code to reproduce the problem
@@ -37,22 +32,22 @@ body:
      required: true
  - type: textarea
    attributes:
-      label: 详细的环境信息描述
-      description: 请提供必要的全部环境信息，包括所有的软件、硬件、驱动等信息. **否则，该问题将被关闭** 
-      placeholder: "包括但不限于该问题出现所依赖的软件及版本、硬件、驱动等信息，尽可能的详细."
+      label: Environment Information
+      description: Provide all necessary environment information (software, hardware, drivers, etc.).
+      placeholder: "Include software versions, hardware, drivers, and other relevant details."
    validations:
      required: true
  - type: textarea
    attributes:
-      label: 其他辅助信息
-      description: 任何其他有助于我们定位问题的信息，请您提供 
+      label: Version Information
+      description: If multiple versions are involved, please provide all version numbers.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: Any other information that helps us locate the issue. 
      placeholder: "Any other things you would like to mention."
-  - type: textarea
-    attributes:
-      label: 版本信息
-      description: 如果涉及多个版本，请悉数告知我们对应的版本号信息，以方便我们复现问题
-    validations:
-      required: true
  - type: markdown
    attributes:
      value: >
@@ -6,20 +6,20 @@ labels: ["documentation"]
 body:
 - type: textarea
  attributes:
-    label: 📚 文档问题描述
+    label: 📚 Documentation Issue
    description: >
-      A clear and concise description of what content in https://gitcode.com/openHiTLS/openhitls is an issue.
+      Describe the documentation issue.
  validations:
    required: true
 - type: textarea
  attributes:
-    label: 改进与修复建议
+    label: Improvement Suggestions
    description: >
-      Tell us how we could improve the documentation in this regard.
+      Suggest improvements, if any.
 - type: textarea
  attributes:
-    label: 版本信息
-    description: 如果涉及多个版本，请悉数告知我们对应的版本号信息，以方便我们复现问题
+    label: Version Information
+    description: If multiple versions are involved, please provide all version numbers.
  validations:
    required: true
 - type: markdown
@@ -6,40 +6,16 @@ labels: ["feature"]
 body:
 - type: textarea
  attributes:
-    label: 🚀 背景描述
+    label: 🚀 Background Description
    description: >
-      A clear and concise description of the feature proposal. Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., *"I'm working on X and would like Y to be possible"*. If this is related to another Gitee issue, please link here too.
+      Describe the feature proposal and its motivation. If related to another issue, please link it here.
  validations:
    required: true
 - type: textarea
  attributes:
-    label: 设计思路
+    label: Module Dependencies
    description: >
-      A description of any alternative solutions or features you've considered, if any.
-  validations:
-    required: true
- type: textarea
-  attributes:
-    label: 涉及到的对外API
-    description: >
-      描述该特性是否会有对外API的增加与变更情况的发生，以及变更可能会造成的周边影响.    
- type: textarea
-  attributes:
-    label: 与其他模块的相关性描述
-    description: >
-      描述与其他模块存在的可能关联性，以方便补充对应的场景验证.
- type: textarea
-  attributes:
-    label: 测试设计与测试计划
-    description: >
-      详细描述如何开展测试验证，以保证该特性的能力得到充分的验证，包括到不限于功能、性能、可靠性、安全等.
-  validations:
-    required: true
- type: textarea
-  attributes:
-    label: 其他信息
-    description: >
-      添加例如辅助信息、场景等内容.
+      Describe relationships with other modules, if any.
 - type: markdown
  attributes:
    value: >
@@ -6,26 +6,26 @@


 **What does this PR do / why do we need it**:
-* Need to describe clearly

+---

 **Which issue(s) this PR fixes**:
 <!-- 
-*Automatically closes linked issue when PR is merged.
-Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.
+Note: Only enter the issue number or SR/AR number after the # sign below. Pasting issue links is invalid.
 -->
 Fixes #

+---

-**What scenarios were tested, and what were the verification results（Function, performance, reliability, etc.）**：
-* Need to describe clearly
+**Test Plan and Test Result**:

+---

-**Self-checklist**:（**Please check carefully,and mark an x in the [] brackets. We will review your completion status.**）
+**Self-checklist**:

-+ - [ ] **Test**: Has the code in the PR been fully covered by UT/ST test cases, and have the newly added test cases been uploaded to the repository along with this PR or already uploaded.
-+ - [ ] **Interface**: Does it involve changes to external interfaces? The corresponding changes have been approved by the interface review organization, and the annotation information for the API has been correctly refreshed.
-+ - [ ] **Document**: Does it involve modifications to the official website documentation? If so, please submit the materials to the Doc repository in a timely manner.
+- [ ] **Test**: Code is covered by UT/ST test cases, and new test cases are included.
+- [ ] **Interface**: If external interface changes are involved, changes have been approved by the TC.
+- [ ] **Document**: If official website documentation changes are involved

 <!-- **Special notes for your reviewers**: -->
 <!-- + - [ ] Whether it causes forward compatibility failure -->
@@ -1,33 +1,32 @@
-<!--  Thanks for sending a pull request!  Here are some tips for you:
+<!--  感谢您提交 Pull Request！以下是一些提示：

-1) If this is your first time, please read our contributor guidelines: https://gitcode.com/openHiTLS/openhitls/wiki/FAQ-%E7%A4%BE%E5%8C%BA%E9%9C%80%E6%B1%82%E8%B4%A1%E7%8C%AE%E6%B5%81%E7%A8%8B.md
+1) 如果您是第一次提交，请阅读我们的贡献者指南：https://gitcode.com/openHiTLS/openhitls/wiki/FAQ-%E7%A4%BE%E5%8C%BA%E9%9C%80%E6%B1%82%E8%B4%A1%E7%8C%AE%E6%B5%81%E7%A8%8B.md

 -->


-**What does this PR do / why do we need it**:
+**此 PR 的作用 / 为什么需要它**：

 ---

-**Which issue(s) this PR fixes**:
+**此 PR 修复的问题**：
 <!-- 
 注意：在下方 #号 后仅输入issue编号或SR/AR编号，粘贴issue链接无效。
-如PR描述不符合规范，修改PR描述后需要/check-pr重新检查PR规范。
 -->
 Fixes #

 ---

-**Test Plan and Test result：What scenarios were tested, and what were the verification results（Function, performance, reliability, etc.）**：
+**测试计划和测试结果**：

 ---

-**Self-checklist**:（**请自检，在[ ]内打上x**）
+**自检清单**：

-+ - [ ] **测试**：PR中的代码是否已有UT/ST测试用例进行充分的覆盖，新增测试用例是否随本PR一并上库或已经上库
-+ - [ ] **接口**：是否涉及对外接口变更，相应变更已得到接口评审组织的通过，API对应的注释信息已经刷新正确
-+ - [ ] **文档**：是否涉及官网文档修改，如果涉及请及时提交资料到Doc仓
+- [ ] **测试**：代码是否已有UT/ST测试用例覆盖，新增测试用例是否随本PR一并上库
+- [ ] **接口**：是否涉及对外接口变更，变更已通过接口评审
+- [ ] **文档**：是否涉及文档修改

-<!-- **Special notes for your reviewers**: -->
+<!-- **给审查者的特别说明**： -->
 <!-- + - [ ] 是否导致无法前向兼容 -->
 <!-- + - [ ] 是否涉及依赖的三方库变更 -->