From 5622874eac62995e7bf47d2a69525abfd7f7e1b5 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Thu, 25 Jul 2024 11:47:37 +0800 Subject: [PATCH] chore: update issue templates (#6375) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #### What type of PR is this? /area core #### What this PR does / why we need it: 更新 issue 模板，可以在 https://github.com/ruibaby/halo/blob/chore/update-issues-templates/.github/ISSUE_TEMPLATE/bug_report.zh.yml 中预览效果。 #### Does this PR introduce a user-facing change? ```release-note None ``` --- .github/ISSUE_TEMPLATE/bug_report.en.yml | 29 ++++++++++++++++++- .github/ISSUE_TEMPLATE/bug_report.zh.yml | 28 +++++++++++++++++- .github/ISSUE_TEMPLATE/feature_request.en.yml | 9 +++++- .github/ISSUE_TEMPLATE/feature_request.zh.yml | 9 +++++- 4 files changed, 71 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.en.yml b/.github/ISSUE_TEMPLATE/bug_report.en.yml index adb45a7bc..16d34d0ca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.en.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.en.yml @@ -5,7 +5,14 @@ body: - type: markdown id: preface attributes: - value: "Thanks for taking the time to fill out this bug report!" + value: | + Thank you for taking the time to fill out this issue report! Before we begin, we highly recommend reading through the [Open Source Guides](https://opensource.guide/), which will greatly improve our mutual efficiency. + + **Before submitting, please check:** + + - You have searched for related issues in the [issues](https://github.com/halo-dev/halo/issues) list. + - This is an issue with the Halo project itself. If it is not an issue with the project itself(For example: Installation and deployment issues.), it is recommended to submit it in the [Discussions](https://github.com/halo-dev/halo/discussions). + - If it is an issue with plugins and themes, please submit it in the respective plugin and theme repositories. - type: markdown id: environment attributes: @@ -15,6 +22,18 @@ body: attributes: label: "System information" description: "Access the actuator page of the Console, click the copy button in the upper right corner, and paste the information here." + placeholder: | + - External url: https://demo.halo.run + - Start time: 2024-07-21 14:50 + - Version: 2.x.x + - Build time: 2024-07-15 18:19 + - Git Commit: 6d4bedd + - Java: IBM Semeru Runtime Open Edition / ... + - Database: PostgreSQL / 16.3 ... + - Operating system: Linux / 5.15.0-88 ... + - Activated theme: ... + - Enabled plugins: + - ... validations: required: true - type: dropdown @@ -39,6 +58,14 @@ body: description: "For ease of management, please do not report multiple unrelated issues under the same issue." validations: required: true + - type: textarea + id: reproduce-steps + attributes: + label: "Reproduce Steps" + description: "If it can be consistently reproduced, please provide detailed steps." + placeholder: | + 1. Open '...' + 2. Click '...' - type: textarea id: logs attributes: diff --git a/.github/ISSUE_TEMPLATE/bug_report.zh.yml b/.github/ISSUE_TEMPLATE/bug_report.zh.yml index 3f7bc9cbc..7d14ce7e9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.zh.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.zh.yml @@ -6,7 +6,13 @@ body: id: preface attributes: value: | - 感谢你花时间填写此错误报告！在开始之前，我们非常推荐阅读一遍[《开源最佳实践》](https://github.com/LinuxSuRen/open-source-best-practice)，这会在很大程度上提高我们彼此的效率。 + 感谢你花时间填写此错误报告！在开始之前，我们非常推荐阅读一遍[《开源软件指南》](https://opensource.guide/zh-hans/)，这会在很大程度上提高我们彼此的效率。 + + **在提交之前，请检查：** + + - 已经在 [issues](https://github.com/halo-dev/halo/issues) 列表中搜索了相关问题。 + - 这是 Halo 项目本身存在的问题，如果是非项目本身的问题（如：安装部署问题），建议在 [Discussions](https://github.com/halo-dev/halo/discussions) 提交。 + - 如果是插件和主题的问题，请在对应的插件和主题仓库提交。 - type: markdown id: environment attributes: @@ -16,6 +22,18 @@ body: attributes: label: "系统信息" description: "访问 Console 的概览页面，点击右上角的复制按钮，将信息粘贴到此处。" + placeholder: | + - 外部访问地址: https://demo.halo.run + - 启动时间: 2024-07-21 14:50 + - 版本: 2.x.x + - 构建时间: 2024-07-15 18:19 + - Git Commit: 6d4bedd + - Java: IBM Semeru Runtime Open Edition / ... + - 数据库: PostgreSQL / 16.3 ... + - 操作系统: Linux / 5.15.0-88 ... + - 已激活主题: ... + - 已启动插件: + - ... validations: required: true - type: dropdown @@ -40,6 +58,14 @@ body: description: "为了方便我们管理，请不要在同一个 issue 下报告多个不相关的问题。" validations: required: true + - type: textarea + id: reproduce-steps + attributes: + label: "复现步骤" + description: "如果可以稳定复现，请提供详细的步骤。" + placeholder: | + 1. 打开 '...' + 2. 点击 '...' - type: textarea id: logs attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.en.yml b/.github/ISSUE_TEMPLATE/feature_request.en.yml index fa8d5d13a..e00b70724 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.en.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.en.yml @@ -4,7 +4,14 @@ body: - type: markdown id: preface attributes: - value: "Hello there! Thank you for submitting new features for Halo. Please spend a little bit to fill in the following instructions in detail." + value: | + Hello! Thank you for submitting a new feature suggestion for Halo. Before we begin, we highly recommend reading through the [Open Source Guides](https://opensource.guide/), which will greatly improve our mutual efficiency. + + **Before submitting, please check:** + + - You have searched for related issues in the [issues](https://github.com/halo-dev/halo/issues) list. + - This is a feature related to Halo. If it is not an issue with the project itself, it is recommended to submit it in the [Discussions](https://github.com/halo-dev/halo/discussions). + - If it is a feature suggestion for plugins and themes, please submit it in the respective plugin and theme repositories. - type: markdown id: environment attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.zh.yml b/.github/ISSUE_TEMPLATE/feature_request.zh.yml index 992658112..5768cb3cc 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.zh.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.zh.yml @@ -4,7 +4,14 @@ body: - type: markdown id: preface attributes: - value: "你好！感谢你为 Halo 提交新特性建议。在开始之前，我们非常推荐阅读一遍[《开源最佳实践》](https://github.com/LinuxSuRen/open-source-best-practice)，这会在很大程度上提高我们彼此的效率。" + value: | + 你好！感谢你为 Halo 提交新特性建议。在开始之前，我们非常推荐阅读一遍[《开源软件指南》](https://opensource.guide/zh-hans/)，这会在很大程度上提高我们彼此的效率。 + + **在提交之前，请检查：** + + - 已经在 [issues](https://github.com/halo-dev/halo/issues) 列表中搜索了相关问题。 + - 这是和 Halo 相关的特性，如果是非项目本身的问题，建议在 [Discussions](https://github.com/halo-dev/halo/discussions) 提交。 + - 如果是插件和主题特性建议，请在对应的插件和主题仓库提交。 - type: markdown id: environment attributes: