From b2daf0a5c37b83d6d140dda024d41c8b0e642ffb Mon Sep 17 00:00:00 2001 From: xu_zh Date: Tue, 26 Aug 2025 15:07:47 +0800 Subject: [PATCH] misc(issue_template): update label names & fix typo (#4960) --- .github/ISSUE_TEMPLATE/1-bug_report.yml | 53 ++++++++++------ .github/ISSUE_TEMPLATE/2-feature_request.yaml | 17 +++--- .github/ISSUE_TEMPLATE/3-problem.yaml | 60 +++++++++++-------- .github/ISSUE_TEMPLATE/4-other_question.yml | 10 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- 5 files changed, 86 insertions(+), 56 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug_report.yml b/.github/ISSUE_TEMPLATE/1-bug_report.yml index aa89135f6..f1f995ac5 100644 --- a/.github/ISSUE_TEMPLATE/1-bug_report.yml +++ b/.github/ISSUE_TEMPLATE/1-bug_report.yml @@ -1,11 +1,13 @@ name: Bug report description: Report a bug (incorrect behaviors) of XiangShan Processor Cores. -labels: 'bug report' +labels: + - 'type: bug/reported' + - 'module: unknown' body: - type: markdown attributes: value: | - You could use English or Chineses to open an issue. + You could use English or Chinese to open an issue. 您可以使用中文或英文提问，我们推荐使用英文。 This template is only used for reporting a bug (incorrect behaviors) of XiangShan Processor Cores. If this doesn't look right, please back and choose another template. @@ -39,9 +41,15 @@ body: attributes: label: Describe the bug description: | - A clear and concise description of what the bug is. 请清晰、准确地描述这一缺陷。 - If applicable, add screenshots to help explain your problem. 如果可能，请提供有助于您描述问题的屏幕截图。 - placeholder: + A clear and concise description of what the bug is. + 请清晰、准确地描述这一缺陷。 + + If applicable, add screenshots / logs to help explain your problem. + 如果可能，请提供有助于您描述问题的屏幕截图和日志。 + + Please upload logs as attachments, do not paste them directly into the text box. + 请使用附件的形式上传日志，不要直接粘贴到文本框中。 + placeholder: validations: required: true - type: textarea @@ -49,8 +57,9 @@ body: attributes: label: Expected behavior description: | - A clear and concise description of what you expected to happen. 请清晰、准确地描述期望的行为。 - placeholder: + A clear and concise description of what you expected to happen. + 请清晰、准确地描述期望的行为。 + placeholder: validations: required: true - type: textarea @@ -58,8 +67,9 @@ body: attributes: label: To Reproduce description: | - Steps to reproduce the bug. Also a corresponding minimal workload (source code and bin) along with a description. 复现这一缺陷的步骤，以及相关的最小测试用例（包含源码、二进制文件和说明）。 - placeholder: + Steps to reproduce the bug. Also a corresponding minimal workload (source code and bin) along with a description. + 复现这一缺陷的步骤，以及相关的最小测试用例（包含源码、二进制文件和说明）。 + placeholder: validations: required: true - type: textarea @@ -69,23 +79,28 @@ body: description: | Please provide your environment information. 请提供您的环境信息。 - - XiangShan config specifies the XiangShan compilation options specified by `CONFIG=` when compiling XiangShan. If no option is specified, the default is `DefaultConfig`. + + XiangShan config specifies the XiangShan compilation options specified by `CONFIG=` when compiling XiangShan. If no option is specified, the default is `DefaultConfig`. XiangShan config 为您编译香山时由 `CONFIG=` 指定的香山编译选项，如果没有显示指定，则默认为 `DefaultConfig`。 - placeholder: + placeholder: value: | - - XiangShan branch: - - XiangShan commit id: - - XiangShan config: - - NEMU commit id: - - SPIKE commit id: + - XiangShan branch: + - XiangShan commit id: + - XiangShan config: + - NEMU commit id: + - SPIKE commit id: validations: required: true - type: textarea id: additional attributes: label: Additional context - description: Add any other context about the problem here. 可在此处附上其他相关信息。 - placeholder: + description: | + Add any other context about the problem here. + 可在此处附上其他相关信息。 + + For example, your guess about the cause of the bug, or the modules that may be related. + 例如，您对 bug 可能原因的猜测，或者可能与 bug 相关的模块。 + placeholder: validations: required: false diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yaml b/.github/ISSUE_TEMPLATE/2-feature_request.yaml index 15db911b6..6762eb2dc 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yaml @@ -1,11 +1,12 @@ name: Feature request description: Suggest an idea for XiangShan project. -labels: 'feature request' +labels: + - 'type: feature/requested' body: - type: markdown attributes: value: | - You could use English or Chineses to open an issue. + You could use English or Chinese to open an issue. 您可以使用中文或英文提问，我们推荐使用英文。 This template is only used for suggesting an idea for XiangShan project. If this doesn't look right, please back and choose another template. @@ -36,16 +37,18 @@ body: attributes: label: Describe the feature you'd like description: | - A clear and concise description of what you want. 请清晰、准确地描述您期望的特性。 - Also your consideration of that. 以及您的具体考虑。 - placeholder: + A clear and concise description of what you want, and, your consideration of that. + 请清晰、准确地描述您期望的特性，以及您的具体考虑。 + placeholder: validations: required: true - type: textarea id: additional attributes: label: Additional context - description: Add any other context about the problem here. 可在此处附上其他相关信息。 - placeholder: + description: | + Add any other context about the problem here. + 可在此处附上其他相关信息。 + placeholder: validations: required: false diff --git a/.github/ISSUE_TEMPLATE/3-problem.yaml b/.github/ISSUE_TEMPLATE/3-problem.yaml index cf5de461c..8122f9b11 100644 --- a/.github/ISSUE_TEMPLATE/3-problem.yaml +++ b/.github/ISSUE_TEMPLATE/3-problem.yaml @@ -1,11 +1,12 @@ name: Problem description: Problem encountered when compiling XiangShan, running EMU, etc. -labels: 'problem' +labels: + - 'type: problem' body: - type: markdown attributes: value: | - You could use English or Chineses to open an issue. + You could use English or Chinese to open an issue. 您可以使用中文或英文提问，我们推荐使用英文。 This template is only used for problem encountered when compiling XiangShan, running EMU, etc. If this doesn't look right, please back and choose another template. @@ -37,9 +38,12 @@ body: attributes: label: Describe you problem description: | - A clear and concise description of what the problem is. 请清晰、准确地描述您遇到的问题。 - If applicable, add screenshots to help explain your problem. 建议您附上遇到问题时的屏幕截图。 - placeholder: + A clear and concise description of what the problem is. + 请清晰、准确地描述您遇到的问题。 + + If applicable, add screenshots to help explain your problem. + 建议您附上遇到问题时的屏幕截图。 + placeholder: validations: required: true - type: textarea @@ -47,9 +51,12 @@ body: attributes: label: What did you do before description: | - Please describe step by step what did you do before you encounted the problem. 请描述您遇到问题前都做了哪些操作。 - This will help us to reproduce your problem. 这将有助于我们复现您的问题。 - placeholder: + Please describe step by step what did you do before you encountered the problem. + 请描述您遇到问题前都做了哪些操作。 + + This will help us to reproduce your problem. + 这将有助于我们复现您的问题。 + placeholder: validations: required: true - type: textarea @@ -57,33 +64,36 @@ body: attributes: label: Environment description: | - Please provide your environment information. 请提供您的环境信息。 - - XiangShan config specifies the XiangShan compilation options specified by `CONFIG=` when compiling XiangShan. If no option is specified, the default is `DefaultConfig`. + Please provide your environment information. + 请提供您的环境信息。 + + XiangShan config specifies the XiangShan compilation options specified by `CONFIG=` when compiling XiangShan. If no option is specified, the default is `DefaultConfig`. XiangShan config 为您编译香山时由 `CONFIG=` 指定的香山编译选项，如果没有显示指定，则默认为 `DefaultConfig`。 - - Tips: + + Tips: - gcc version: **run `gcc --version` and paste first line of the output** - mill version: **run `mill -i --version` and paste first line of the output** - java version: **run `java --version` and paste first line of the output** - placeholder: + placeholder: value: | - - XiangShan branch: - - XiangShan commit id: - - XiangShan config: - - NEMU commit id: - - SPIKE commit id: - - Operating System: - - gcc version: - - mill version: - - java version: + - XiangShan branch: + - XiangShan commit id: + - XiangShan config: + - NEMU commit id: + - SPIKE commit id: + - Operating System: + - gcc version: + - mill version: + - java version: validations: required: true - type: textarea id: additional attributes: label: Additional context - description: Add any other context about the problem here. 可在此处附上其他相关信息。 - placeholder: + description: | + Add any other context about the problem here. + 可在此处附上其他相关信息。 + placeholder: validations: required: false diff --git a/.github/ISSUE_TEMPLATE/4-other_question.yml b/.github/ISSUE_TEMPLATE/4-other_question.yml index 7d7073e17..25b97c403 100644 --- a/.github/ISSUE_TEMPLATE/4-other_question.yml +++ b/.github/ISSUE_TEMPLATE/4-other_question.yml @@ -1,11 +1,12 @@ name: Other Question description: Any other question about XiangShan. -labels: 'question' +labels: + 'type: question' body: - type: markdown attributes: value: | - You could use English or Chineses to open an issue. + You could use English or Chinese to open an issue. 您可以使用中文或英文提问，我们推荐使用英文。 This template is only used for the questions that do not fit other templates. Please check other templates before using this. @@ -36,7 +37,8 @@ body: attributes: label: Describe the question description: | - A clear and concise description of your question. 请清晰、准确地描述您的问题。 - placeholder: + A clear and concise description of your question. + 请清晰、准确地描述您的问题。 + placeholder: validations: required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 14c124562..1899bd636 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ blank_issues_enabled: false contact_links: - - name: RISC-V ISA Quesion / Problem + - name: RISC-V ISA Question / Problem url: https://github.com/riscv/riscv-isa-manual/issues about: Ask RISC-V ISA questions here. - name: NEMU Question / Problem