Преглед изворни кода

[ci]Refactor issue templates for bug reports and feature requests.

dufu1991 пре 1 година
родитељ
комит
daef450834

+ 54 - 55
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -3,64 +3,63 @@ description: Report an issue with STDF
 title: '[Bug]: '
 labels: ['bug']
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to fill out this bug report! If you have a usage question or are unsure if it's really a bug, please make sure:
+    - type: markdown
+      attributes:
+          value: |
+              Thank you for taking the time to fill out this bug report! If you have a usage question or are unsure if it's really a bug, please make sure:
 
-        - You are using the latest version of the code.
-        - You have checked the open and closed issues to see if your issue has already been reported.
-        - If there is a similar issue in the issues list, please provide additional information in the corresponding issue.
-        - Your description of the problem is concise and clear, not just from your own perspective.
+              - You are using the latest version of the code.
+              - You have checked the open and closed issues to see if your issue has already been reported.
+              - If there is a similar issue in the issues list, please provide additional information in the corresponding issue.
+              - Your description of the problem is concise and clear, not just from your own perspective.
 
-  - type: dropdown
-    id: module
-    attributes:
-      label: Module
-      description: Which module does this bug belong to?
-      options:
-        - stdf (STDF component)
-        - create (create-stdf scaffolding)
-        - vscode (STDF VS Code plugin)
-        - icon (rollup-plugin-stdf-icon plugin)
-        - site (STDF website)
-        - demo (STDF demo)
-        - doc (STDF documentation, including components && guide)
-        - other (other)
-    validations:
-      required: true
+    - type: dropdown
+      id: module
+      attributes:
+          label: Module
+          description: Which module does this bug belong to?
+          options:
+              - stdf (STDF component)
+              - create (create-stdf scaffolding)
+              - vscode (STDF VS Code plugin)
+              - icon (rollup-plugin-stdf-icon plugin)
+              - demo (STDF demo)
+              - doc (STDF site and documentation)
+              - other (other)
+      validations:
+          required: true
 
-  - type: input
-    id: version
-    attributes:
-      label: Version
-      description: If it is stdf/create/icon/vscode, please indicate the version in which this bug occurred.
-    validations:
-      required: false
+    - type: input
+      id: version
+      attributes:
+          label: Version
+          description: If it is stdf/create/icon/vscode, please indicate the version in which this bug occurred.
+      validations:
+          required: false
 
-  - type: textarea
-    id: bug-description
-    attributes:
-      label: Bug Description
-      description: Please describe the bug clearly and concisely.
-      placeholder: When...
-    validations:
-      required: true
+    - type: textarea
+      id: bug-description
+      attributes:
+          label: Bug Description
+          description: Please describe the bug clearly and concisely.
+          placeholder: When...
+      validations:
+          required: true
 
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Reproduction
-      description: You can use text/images/short videos to explain how to reproduce the issue, but please provide a series of information about the environment where the problem occurs, such as device model and version, operating system and version, browser, etc. You can also use [StackBlitz](https://stackblitz.com) or [CodePen](https://codepen.io) or other online IDEs to quickly create a project to demonstrate the bug. In short, make it easy for others to understand how to reproduce the bug.
-      placeholder: On iPhone 13 Pro with iOS 16...
-    validations:
-      required: true
+    - type: textarea
+      id: reproduction
+      attributes:
+          label: Reproduction
+          description: You can use text/images/short videos to explain how to reproduce the issue, but please provide a series of information about the environment where the problem occurs, such as device model and version, operating system and version, browser, etc. You can also use [StackBlitz](https://stackblitz.com) or [CodePen](https://codepen.io) or other online IDEs to quickly create a project to demonstrate the bug. In short, make it easy for others to understand how to reproduce the bug.
+          placeholder: On iPhone 13 Pro with iOS 16...
+      validations:
+          required: true
 
-  - type: textarea
-    id: idea
-    attributes:
-      label: Your Idea
-      description: If you have a solution or idea for this bug, you can describe it here.
-      placeholder: I think...
-    validations:
-      required: false
+    - type: textarea
+      id: idea
+      attributes:
+          label: Your Idea
+          description: If you have a solution or idea for this bug, you can describe it here.
+          placeholder: I think...
+      validations:
+          required: false

+ 54 - 55
.github/ISSUE_TEMPLATE/bug_report_CN.yml

@@ -3,64 +3,63 @@ description: 报告 STDF 问题
 title: '[Bug]: '
 labels: ['bug']
 body:
-  - type: markdown
-    attributes:
-      value: |
-        感谢您抽出时间填写这份错误报告!如果您有使用问题,或者不确定是否真的是一个错误,请确保:
+    - type: markdown
+      attributes:
+          value: |
+              感谢您抽出时间填写这份错误报告!如果您有使用问题,或者不确定是否真的是一个错误,请确保:
 
-        - 你使用的是最新版代码。
-        - 你已经查看过开启与关闭状态的 issues ,其中并没有你发现的此问题。
-        - 如果 issues 中已有相同问题,你需要补充,请尽量在对应的 issue 中补充讨论。
-        - 你对问题的表述简洁清晰,不只在你的情景角度能理解。
+              - 你使用的是最新版代码。
+              - 你已经查看过开启与关闭状态的 issues ,其中并没有你发现的此问题。
+              - 如果 issues 中已有相同问题,你需要补充,请尽量在对应的 issue 中补充讨论。
+              - 你对问题的表述简洁清晰,不只在你的情景角度能理解。
 
-  - type: dropdown
-    id: module
-    attributes:
-      label: 模块
-      description: 此缺陷属于哪个模块?
-      options:
-        - stdf (STDF 组件)
-        - create (create-stdf 脚手架)
-        - vscode (STDF VS Code 插件)
-        - icon (rollup-plugin-stdf-icon 插件)
-        - site (STDF 站点)
-        - demo (STDF demo)
-        - doc (STDF 文档,包括 components && guide)
-        - other (其他)
-    validations:
-      required: true
+    - type: dropdown
+      id: module
+      attributes:
+          label: 模块
+          description: 此缺陷属于哪个模块?
+          options:
+              - stdf (STDF 组件)
+              - create (create-stdf 脚手架)
+              - vscode (STDF VS Code 插件)
+              - icon (rollup-plugin-stdf-icon 插件)
+              - demo (STDF demo)
+              - doc (STDF 站点与文档)
+              - other (其他)
+      validations:
+          required: true
 
-  - type: input
-    id: version
-    attributes:
-      label: 版本
-      description: 如果是选择的是 stdf、create、icon、vscode,请注明此缺陷出现的版本。
-    validations:
-      required: false
+    - type: input
+      id: version
+      attributes:
+          label: 版本
+          description: 如果是选择的是 stdf、create、icon、vscode,请注明此缺陷出现的版本。
+      validations:
+          required: false
 
-  - type: textarea
-    id: bug-description
-    attributes:
-      label: 描述缺陷
-      description: 请清晰简明地描述清楚该缺陷内容。
-      placeholder: 当...
-    validations:
-      required: true
+    - type: textarea
+      id: bug-description
+      attributes:
+          label: 描述缺陷
+          description: 请清晰简明地描述清楚该缺陷内容。
+          placeholder: 当...
+      validations:
+          required: true
 
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: 复现
-      description: 你可以使用文字/图片/简短视频说清楚如何复现此问题,但请尽量说清设备型号与版本、操作系统与版本、浏览器等一系列出现问题的环境。也可以使用 [StackBlitz](https://stackblitz.com) 或者 [CodePen](https://codepen.io) 或其他在线 IDE 快速创建一个工程展示此缺陷。总之让别人能快速明白此缺陷的复现情况。
-      placeholder: 在 iPhone 13 Pro 的 iOS 16...
-    validations:
-      required: true
+    - type: textarea
+      id: reproduction
+      attributes:
+          label: 复现
+          description: 你可以使用文字/图片/简短视频说清楚如何复现此问题,但请尽量说清设备型号与版本、操作系统与版本、浏览器等一系列出现问题的环境。也可以使用 [StackBlitz](https://stackblitz.com) 或者 [CodePen](https://codepen.io) 或其他在线 IDE 快速创建一个工程展示此缺陷。总之让别人能快速明白此缺陷的复现情况。
+          placeholder: 在 iPhone 13 Pro 的 iOS 16...
+      validations:
+          required: true
 
-  - type: textarea
-    id: idea
-    attributes:
-      label: 你的想法
-      description: 如果你对该缺陷有解决方案或思路,可以在这里描述。
-      placeholder: 我认为...
-    validations:
-      required: false
+    - type: textarea
+      id: idea
+      attributes:
+          label: 你的想法
+          description: 如果你对该缺陷有解决方案或思路,可以在这里描述。
+          placeholder: 我认为...
+      validations:
+          required: false

+ 47 - 48
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -3,56 +3,55 @@ description: Submit a request for a new feature
 title: '[Feature]: '
 labels: ['enhancement']
 body:
-  - type: markdown
-    attributes:
-      value: |
-        Thank you for taking the time to fill out this feature request! If you have a new idea or are unsure if it can be implemented, please make sure:
+    - type: markdown
+      attributes:
+          value: |
+              Thank you for taking the time to fill out this feature request! If you have a new idea or are unsure if it can be implemented, please make sure:
 
-        - You have checked the latest version of the code and confirmed that the feature does not exist.
-        - You have checked the open and closed issues to see if the feature you want to add has been described.
-        - If there is a similar feature request in the issues list, please provide additional information in the corresponding issue.
-        - Your description of the new feature is concise and clear, not just from your own perspective.
+              - You have checked the latest version of the code and confirmed that the feature does not exist.
+              - You have checked the open and closed issues to see if the feature you want to add has been described.
+              - If there is a similar feature request in the issues list, please provide additional information in the corresponding issue.
+              - Your description of the new feature is concise and clear, not just from your own perspective.
 
-  - type: dropdown
-    id: module
-    attributes:
-      label: Module
-      description: Which module does this new feature belong to?
-      options:
-        - stdf (STDF component)
-        - create (create-stdf scaffolding)
-        - vscode (STDF VS Code plugin)
-        - icon (rollup-plugin-stdf-icon plugin)
-        - site (STDF website)
-        - demo (STDF demo)
-        - doc (STDF documentation, including components && guide)
-        - other (other)
-    validations:
-      required: true
+    - type: dropdown
+      id: module
+      attributes:
+          label: Module
+          description: Which module does this new feature belong to?
+          options:
+              - stdf (STDF component)
+              - create (create-stdf scaffolding)
+              - vscode (STDF VS Code plugin)
+              - icon (rollup-plugin-stdf-icon plugin)
+              - demo (STDF demo)
+              - doc (STDF site and documentation)
+              - other (other)
+      validations:
+          required: true
 
-  - type: textarea
-    id: description
-    attributes:
-      label: Feature Description
-      description: Please describe the new feature clearly and concisely.
-      placeholder: When...
-    validations:
-      required: true
+    - type: textarea
+      id: description
+      attributes:
+          label: Feature Description
+          description: Please describe the new feature clearly and concisely.
+          placeholder: When...
+      validations:
+          required: true
 
-  - type: textarea
-    id: example
-    attributes:
-      label: Example
-      description: You can provide some similar implementations in other projects to help others understand your idea.
-      placeholder: In...
-    validations:
-      required: false
+    - type: textarea
+      id: example
+      attributes:
+          label: Example
+          description: You can provide some similar implementations in other projects to help others understand your idea.
+          placeholder: In...
+      validations:
+          required: false
 
-  - type: textarea
-    id: idea
-    attributes:
-      label: Your Idea
-      description: If you have any implementation ideas or thoughts about the new feature, you can describe them here.
-      placeholder: I think...
-    validations:
-      required: false
+    - type: textarea
+      id: idea
+      attributes:
+          label: Your Idea
+          description: If you have any implementation ideas or thoughts about the new feature, you can describe them here.
+          placeholder: I think...
+      validations:
+          required: false

+ 47 - 48
.github/ISSUE_TEMPLATE/feature_request_CN.yml

@@ -3,56 +3,55 @@ description: 提交一个新功能的需求
 title: '[Feature]: '
 labels: ['enhancement']
 body:
-  - type: markdown
-    attributes:
-      value: |
-        感谢您抽出时间填写这份新功能请求报告!如果您有新的想法,或者不确定是否能实现,请确保:
+    - type: markdown
+      attributes:
+          value: |
+              感谢您抽出时间填写这份新功能请求报告!如果您有新的想法,或者不确定是否能实现,请确保:
 
-        - 你已经查看最新版代码无此功能。
-        - 你已经查看过开启与关闭状态的 issues ,其中并没有你想增加的功能描述。
-        - 如果 issues 中已有相同新功能,你需要补充,请尽量在对应的 issue 中补充讨论。
-        - 你对新功能的表述简洁清晰,不只在你的情景角度能理解。
+              - 你已经查看最新版代码无此功能。
+              - 你已经查看过开启与关闭状态的 issues ,其中并没有你想增加的功能描述。
+              - 如果 issues 中已有相同新功能,你需要补充,请尽量在对应的 issue 中补充讨论。
+              - 你对新功能的表述简洁清晰,不只在你的情景角度能理解。
 
-  - type: dropdown
-    id: module
-    attributes:
-      label: 模块
-      description: 此新功能属于哪个模块?
-      options:
-        - stdf (STDF 组件)
-        - create (create-stdf 脚手架)
-        - vscode (STDF VS Code 插件)
-        - icon (rollup-plugin-stdf-icon 插件)
-        - site (STDF 站点)
-        - demo (STDF demo)
-        - doc (STDF 文档,包括 components && guide)
-        - other (其他)
-    validations:
-      required: true
+    - type: dropdown
+      id: module
+      attributes:
+          label: 模块
+          description: 此新功能属于哪个模块?
+          options:
+              - stdf (STDF 组件)
+              - create (create-stdf 脚手架)
+              - vscode (STDF VS Code 插件)
+              - icon (rollup-plugin-stdf-icon 插件)
+              - demo (STDF demo)
+              - doc (STDF 站点与文档)
+              - other (其他)
+      validations:
+          required: true
 
-  - type: textarea
-    id: description
-    attributes:
-      label: 新功能描述
-      description: 请清晰简明地描述清楚该新功能内容。
-      placeholder: 当...
-    validations:
-      required: true
+    - type: textarea
+      id: description
+      attributes:
+          label: 新功能描述
+          description: 请清晰简明地描述清楚该新功能内容。
+          placeholder: 当...
+      validations:
+          required: true
 
-  - type: textarea
-    id: example
-    attributes:
-      label: 示例
-      description: 你可以给出一些在其他项目中类似的实现,方便大家理解你的想法。
-      placeholder: 在...
-    validations:
-      required: false
+    - type: textarea
+      id: example
+      attributes:
+          label: 示例
+          description: 你可以给出一些在其他项目中类似的实现,方便大家理解你的想法。
+          placeholder: 在...
+      validations:
+          required: false
 
-  - type: textarea
-    id: idea
-    attributes:
-      label: 你的想法
-      description: 如果你对新功能有实现思路或任何想法,可以在这里描述。
-      placeholder: 我认为...
-    validations:
-      required: false
+    - type: textarea
+      id: idea
+      attributes:
+          label: 你的想法
+          description: 如果你对新功能有实现思路或任何想法,可以在这里描述。
+          placeholder: 我认为...
+      validations:
+          required: false