From 0d825927e1cc6155a04fb8360c531986ffaed7a2 Mon Sep 17 00:00:00 2001 From: fit2bot <68588906+fit2bot@users.noreply.github.com> Date: Wed, 29 May 2024 18:15:13 +0800 Subject: [PATCH] perf: Optimize GitHub labels and update related workflows (#13315) * perf: Optimize GitHub labels and update related workflows * perf: Optimize issue template * perf: Optimize issue template * Update 1_bug_report.yml * Update 1_bug_report.yml * Update 1_bug_report.yml * Update 1_bug_report.yml * Update 1_bug_report.yml * Update 2_feature_request.yml * Update 2_feature_request.yml * Update 3_question.yml * Update 3_question.yml * Update 3_question.yml * Update 1_bug_report.yml * Update 2_feature_request.yml * Update 1_bug_report_cn.yml * Update 1_bug_report_cn.yml * Update 2_feature_request_cn.yml * Update 1_bug_report_cn.yml * Update 1_bug_report_cn.yml * Update 1_bug_report_cn.yml * Update 3_question_cn.yml * Update 1_bug_report_cn.yml * Update 2_feature_request_cn.yml * Update 3_question_cn.yml * Update 2_feature_request_cn.yml * Update 1_bug_report.yml * Update 1_bug_report_cn.yml * Update 2_feature_request.yml * Update 3_question.yml * perf: Optimize issue template --------- Co-authored-by: Bai Co-authored-by: Bryan --- .github/ISSUE_TEMPLATE/----.md | 35 --------- .github/ISSUE_TEMPLATE/1_bug_report.yml | 72 +++++++++++++++++++ .github/ISSUE_TEMPLATE/1_bug_report_cn.yml | 72 +++++++++++++++++++ .github/ISSUE_TEMPLATE/2_feature_request.yml | 56 +++++++++++++++ .../ISSUE_TEMPLATE/2_feature_request_cn.yml | 56 +++++++++++++++ .github/ISSUE_TEMPLATE/3_question.yml | 60 ++++++++++++++++ .github/ISSUE_TEMPLATE/3_question_cn.yml | 61 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug---.md | 51 ------------- .github/ISSUE_TEMPLATE/question.md | 50 ------------- .github/workflows/issue-close-require.yml | 4 +- .github/workflows/issue-close.yml | 2 +- .github/workflows/issue-comment.yml | 8 +-- .github/workflows/issue-open.yml | 2 +- 13 files changed, 386 insertions(+), 143 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/----.md create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report_cn.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request_cn.yml create mode 100644 .github/ISSUE_TEMPLATE/3_question.yml create mode 100644 .github/ISSUE_TEMPLATE/3_question_cn.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug---.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/----.md b/.github/ISSUE_TEMPLATE/----.md deleted file mode 100644 index fb9f8bfd6..000000000 --- a/.github/ISSUE_TEMPLATE/----.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: 需求建议 -about: 提出针对本项目的想法和建议 -title: "[Feature] 需求标题" -labels: 类型:需求 -assignees: - - ibuler - - baijiangjie ---- - -## 注意 -_针对过于简单的需求描述不予考虑。请确保提供足够的细节和信息以支持功能的开发和实现。_ - -## 功能名称 -[在这里输入功能的名称或标题] - -## 功能描述 -[在这里描述该功能的详细内容，包括其作用、目的和所需的功能] - -## 用户故事（可选） -[如果适用，可以提供用户故事来更好地理解该功能的使用场景和用户期望] - -## 功能要求 -- [要求1：描述该功能的具体要求，如界面设计、交互逻辑等] -- [要求2：描述该功能的另一个具体要求] -- [以此类推，列出所有相关的功能要求] - -## 示例或原型（可选） -[如果有的话，提供该功能的示例或原型图以更好地说明功能的实现方式] - -## 优先级 -[描述该功能的优先级，如高、中、低，或使用数字等其他标识] - -## 备注（可选） -[在这里添加任何其他相关信息或备注] diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml new file mode 100644 index 000000000..cc51f50cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml @@ -0,0 +1,72 @@ +name: '🐛 Bug Report' +description: 'Report an Bug' +title: '[Bug] ' +labels: ['🐛 Bug'] +assignees: + - baijiangjie +body: + - type: input + attributes: + label: 'Product Version' + description: The versions prior to v2.28 (inclusive) are no longer supported. + validations: + required: true + + - type: checkboxes + attributes: + label: 'Product Edition' + options: + - label: 'Community Edition' + - label: 'Enterprise Edition' + - label: 'Enterprise Trial Edition' + validations: + required: true + + - type: checkboxes + attributes: + label: 'Installation Method' + options: + - label: 'Online Installation (One-click command installation)' + - label: 'Offline Package Installation' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: 'Source Code' + + - type: textarea + attributes: + label: 'Environment Information' + description: Please provide a clear and concise description outlining your environment information. + validations: + required: true + + - type: textarea + attributes: + label: '🐛 Bug Description' + description: + Please provide a clear and concise description of the defect. If the issue is complex, please provide detailed explanations.
+ Unclear descriptions will not be processed. Please ensure you provide enough detail and information to support replicating and fixing the defect. + validations: + required: true + + - type: textarea + attributes: + label: 'Recurrence Steps' + description: Please provide a clear and concise description outlining how to reproduce the issue. + validations: + required: true + + - type: textarea + attributes: + label: 'Expected Behavior' + description: Please provide a clear and concise description of what you expect to happen. + + - type: textarea + attributes: + label: 'Additional Information' + description: Please add any additional background information about the issue here. + + - type: textarea + attributes: + label: 'Attempted Solutions' + description: If you have already attempted to solve the issue, please list the solutions you have tried here. diff --git a/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml b/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml new file mode 100644 index 000000000..711d789af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml @@ -0,0 +1,72 @@ +name: '🐛 反馈缺陷' +description: '反馈一个缺陷' +title: '[Bug] ' +labels: ['🐛 Bug'] +assignees: + - baijiangjie +body: + - type: input + attributes: + label: '产品版本' + description: 不再支持 v2.28（含）之前的版本。 + validations: + required: true + + - type: checkboxes + attributes: + label: '版本类型' + options: + - label: '社区版' + - label: '企业版' + - label: '企业试用版' + validations: + required: true + + - type: checkboxes + attributes: + label: '安装方式' + options: + - label: '在线安装 (一键命令安装)' + - label: '离线包安装' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: '源码安装' + + - type: textarea + attributes: + label: '环境信息' + description: 请提供一个清晰且简洁的描述，说明你的环境信息。 + validations: + required: true + + - type: textarea + attributes: + label: '🐛 缺陷描述' + description: | + 请提供一个清晰且简洁的缺陷描述，如果问题比较复杂，也请详细说明。
+ 针对不清晰的描述信息将不予处理。请确保提供足够的细节和信息，以支持对缺陷进行复现和修复。 + validations: + required: true + + - type: textarea + attributes: + label: '复现步骤' + description: 请提供一个清晰且简洁的描述，说明如何复现问题。 + validations: + required: true + + - type: textarea + attributes: + label: '期望结果' + description: 请提供一个清晰且简洁的描述，说明你期望发生什么。 + + - type: textarea + attributes: + label: '补充信息' + description: 在这里添加关于问题的任何其他背景信息。 + + - type: textarea + attributes: + label: '尝试过的解决方案' + description: 如果你已经尝试解决问题，请在此列出你尝试过的解决方案。 diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml new file mode 100644 index 000000000..fe715bc2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml @@ -0,0 +1,56 @@ +name: '⭐️ Feature Request' +description: 'Suggest an idea' +title: '[Feature] ' +labels: ['⭐️ Feature Request'] +assignees: + - baijiangjie + - ibuler +body: + - type: input + attributes: + label: 'Product Version' + description: The versions prior to v2.28 (inclusive) are no longer supported. + validations: + required: true + + - type: checkboxes + attributes: + label: 'Product Edition' + options: + - label: 'Community Edition' + - label: 'Enterprise Edition' + - label: 'Enterprise Trial Edition' + validations: + required: true + + - type: checkboxes + attributes: + label: 'Installation Method' + options: + - label: 'Online Installation (One-click command installation)' + - label: 'Offline Package Installation' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: 'Source Code' + + - type: textarea + attributes: + label: '⭐️ Feature Description' + description: | + Please add a clear and concise description of the problem you aim to solve with this feature request.
+ Unclear descriptions will not be processed. + validations: + required: true + + - type: textarea + attributes: + label: 'Proposed Solution' + description: Please provide a clear and concise description of the solution you desire. + validations: + required: true + + - type: textarea + attributes: + label: 'Additional Information' + description: Please add any additional background information about the issue here. diff --git a/.github/ISSUE_TEMPLATE/2_feature_request_cn.yml b/.github/ISSUE_TEMPLATE/2_feature_request_cn.yml new file mode 100644 index 000000000..a3c25a00d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request_cn.yml @@ -0,0 +1,56 @@ +name: '⭐️ 功能需求' +description: '提出需求或建议' +title: '[Feature] ' +labels: ['⭐️ Feature Request'] +assignees: + - baijiangjie + - ibuler +body: + - type: input + attributes: + label: '产品版本' + description: 不再支持 v2.28（含）之前的版本。 + validations: + required: true + + - type: checkboxes + attributes: + label: '版本类型' + options: + - label: '社区版' + - label: '企业版' + - label: '企业试用版' + validations: + required: true + + - type: checkboxes + attributes: + label: '安装方式' + options: + - label: '在线安装 (一键命令安装)' + - label: '离线包安装' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: '源码安装' + + - type: textarea + attributes: + label: '⭐️ 需求描述' + description: | + 请添加一个清晰且简洁的问题描述，阐述你希望通过这个功能需求解决的问题。
+ 针对不清晰的描述信息将不予处理。 + validations: + required: true + + - type: textarea + attributes: + label: '解决方案' + description: 请清晰且简洁地描述你想要的解决方案。 + validations: + required: true + + - type: textarea + attributes: + label: '补充信息' + description: 在这里添加关于问题的任何其他背景信息。 diff --git a/.github/ISSUE_TEMPLATE/3_question.yml b/.github/ISSUE_TEMPLATE/3_question.yml new file mode 100644 index 000000000..df612c795 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_question.yml @@ -0,0 +1,60 @@ +name: '🤔 Question' +description: 'Pose a question' +title: '[Question] ' +labels: ['🤔 Question'] +assignees: + - baijiangjie +body: + - type: input + attributes: + label: 'Product Version' + description: The versions prior to v2.28 (inclusive) are no longer supported. + validations: + required: true + + - type: checkboxes + attributes: + label: 'Product Edition' + options: + - label: 'Community Edition' + - label: 'Enterprise Edition' + - label: 'Enterprise Trial Edition' + validations: + required: true + + - type: checkboxes + attributes: + label: 'Installation Method' + options: + - label: 'Online Installation (One-click command installation)' + - label: 'Offline Package Installation' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: 'Source Code' + + - type: textarea + attributes: + label: 'Environment Information' + description: Please provide a clear and concise description outlining your environment information. + validations: + required: true + + - type: textarea + attributes: + label: '🤔 Question Description' + description: | + Please provide a clear and concise description of the defect. If the issue is complex, please provide detailed explanations.
+ Unclear descriptions will not be processed. + validations: + required: true + + - type: textarea + attributes: + label: 'Expected Behavior' + description: Please provide a clear and concise description of what you expect to happen. + + - type: textarea + attributes: + label: 'Additional Information' + description: Please add any additional background information about the issue here. diff --git a/.github/ISSUE_TEMPLATE/3_question_cn.yml b/.github/ISSUE_TEMPLATE/3_question_cn.yml new file mode 100644 index 000000000..e311b82ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_question_cn.yml @@ -0,0 +1,61 @@ +name: '🤔 问题咨询' +description: '提出一个问题' +title: '[Question] ' +labels: ['🤔 Question'] +assignees: + - baijiangjie +body: + - type: input + attributes: + label: '产品版本' + description: 不再支持 v2.28（含）之前的版本。 + validations: + required: true + + - type: checkboxes + attributes: + label: '版本类型' + options: + - label: '社区版' + - label: '企业版' + - label: '企业试用版' + validations: + required: true + + - type: checkboxes + attributes: + label: '安装方式' + options: + - label: '在线安装 (一键命令安装)' + - label: '离线包安装' + - label: 'All-in-One' + - label: '1Panel' + - label: 'Kubernetes' + - label: '源码安装' + + - type: textarea + attributes: + label: '环境信息' + description: 请在此详细描述你的环境信息，如操作系统、浏览器和部署架构等。 + validations: + required: true + + - type: textarea + attributes: + label: '🤔 问题描述' + description: | + 请提供一个清晰且简洁的问题描述，如果问题比较复杂，也请详细说明。
+ 针对不清晰的描述信息将不予处理。 + validations: + required: true + + - type: textarea + attributes: + label: '期望结果' + description: 请提供一个清晰且简洁的描述，说明你期望发生什么。 + + - type: textarea + attributes: + label: '补充信息' + description: 在这里添加关于问题的任何其他背景信息。 + diff --git a/.github/ISSUE_TEMPLATE/bug---.md b/.github/ISSUE_TEMPLATE/bug---.md deleted file mode 100644 index 2da1561ed..000000000 --- a/.github/ISSUE_TEMPLATE/bug---.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Bug 提交 -about: 提交产品缺陷帮助我们更好的改进 -title: "[Bug] Bug 标题" -labels: 类型:Bug -assignees: - - baijiangjie ---- - -## 注意 -**JumpServer 版本( v2.28 之前的版本不再支持 )**
-_针对过于简单的 Bug 描述不予考虑。请确保提供足够的细节和信息以支持 Bug 的复现和修复。_ - -## 当前使用的 JumpServer 版本 (必填) -[在这里输入当前使用的 JumpServer 的版本号] - -## 使用的版本类型 (必填) -- [ ] 社区版 -- [ ] 企业版 -- [ ] 企业试用版 - - -## 版本安装方式 (必填) -- [ ] 在线安装 (一键命令) -- [ ] 离线安装 (下载离线包) -- [ ] All-in-One -- [ ] 1Panel 安装 -- [ ] Kubernetes 安装 -- [ ] 源码安装 - -## Bug 描述 (详细) -[在这里描述 Bug 的详细情况，包括其影响和出现的具体情况] - -## 复现步骤 -1. [描述如何复现 Bug 的第一步] -2. [描述如何复现 Bug 的第二步] -3. [以此类推，列出所有复现 Bug 所需的步骤] - -## 期望行为 -[描述 Bug 出现时期望的系统行为或结果] - -## 实际行为 -[描述实际上发生了什么，以及 Bug 出现的具体情况] - -## 系统环境 -- 操作系统：[例如：Windows 10, macOS Big Sur] -- 浏览器/应用版本：[如果适用，请提供相关版本信息] -- 其他相关环境信息：[如果有其他相关环境信息，请在此处提供] - -## 附加信息（可选） -[在这里添加任何其他相关信息，如截图、错误信息等] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 3f7d673f0..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: 问题咨询 -about: 提出针对本项目安装部署、使用及其他方面的相关问题 -title: "[Question] 问题标题" -labels: 类型:提问 -assignees: - - baijiangjie ---- -## 注意 -**请描述您的问题.**
-**JumpServer 版本( v2.28 之前的版本不再支持 )**
-_针对过于简单的 Bug 描述不予考虑。请确保提供足够的细节和信息以支持 Bug 的复现和修复。_ - -## 当前使用的 JumpServer 版本 (必填) -[在这里输入当前使用的 JumpServer 的版本号] - -## 使用的版本类型 (必填) -- [ ] 社区版 -- [ ] 企业版 -- [ ] 企业试用版 - - -## 版本安装方式 (必填) -- [ ] 在线安装 (一键命令) -- [ ] 离线安装 (下载离线包) -- [ ] All-in-One -- [ ] 1Panel 安装 -- [ ] Kubernetes 安装 -- [ ] 源码安装 - -## 问题描述 (详细) -[在这里描述你遇到的问题] - -## 背景信息 -- 操作系统：[例如：Windows 10, macOS Big Sur] -- 浏览器/应用版本：[如果适用，请提供相关版本信息] -- 其他相关环境信息：[如果有其他相关环境信息，请在此处提供] - -## 具体问题 -[在这里详细描述你的问题，包括任何相关细节或错误信息] - -## 尝试过的解决方法 -[如果你已经尝试过解决问题，请在这里列出你已经尝试过的解决方法] - -## 预期结果 -[描述你期望的解决方案或结果] - -## 我们的期望 -[描述你希望我们提供的帮助或支持] - diff --git a/.github/workflows/issue-close-require.yml b/.github/workflows/issue-close-require.yml index 3cbee1504..df341f211 100644 --- a/.github/workflows/issue-close-require.yml +++ b/.github/workflows/issue-close-require.yml @@ -12,7 +12,9 @@ jobs: uses: actions-cool/issues-helper@v2 with: actions: 'close-issues' - labels: '状态:待反馈' + labels: '⏳ Pending feedback' inactive-day: 30 body: | + You haven't provided feedback for over 30 days. + We will close this issue. If you have any further needs, you can reopen it or submit a new issue. 您超过 30 天未反馈信息，我们将关闭该 issue，如有需求您可以重新打开或者提交新的 issue。 diff --git a/.github/workflows/issue-close.yml b/.github/workflows/issue-close.yml index d9ed4bab4..1ff51f456 100644 --- a/.github/workflows/issue-close.yml +++ b/.github/workflows/issue-close.yml @@ -13,4 +13,4 @@ jobs: if: ${{ !github.event.issue.pull_request }} with: actions: 'remove-labels' - labels: '状态:待处理,状态:待反馈' \ No newline at end of file + labels: '🔔 Pending processing,⏳ Pending feedback' \ No newline at end of file diff --git a/.github/workflows/issue-comment.yml b/.github/workflows/issue-comment.yml index 980d701cb..66c03b04b 100644 --- a/.github/workflows/issue-comment.yml +++ b/.github/workflows/issue-comment.yml @@ -13,13 +13,13 @@ jobs: uses: actions-cool/issues-helper@v2 with: actions: 'add-labels' - labels: '状态:待处理' + labels: '🔔 Pending processing' - name: Remove require reply label uses: actions-cool/issues-helper@v2 with: actions: 'remove-labels' - labels: '状态:待反馈' + labels: '⏳ Pending feedback' add-label-if-is-member: runs-on: ubuntu-latest @@ -55,11 +55,11 @@ jobs: uses: actions-cool/issues-helper@v2 with: actions: 'add-labels' - labels: '状态:待反馈' + labels: '⏳ Pending feedback' - name: Remove require handle label if: contains(steps.member_names.outputs.data, github.event.comment.user.login) uses: actions-cool/issues-helper@v2 with: actions: 'remove-labels' - labels: '状态:待处理' + labels: '🔔 Pending processing' diff --git a/.github/workflows/issue-open.yml b/.github/workflows/issue-open.yml index 232d5da29..b1555e113 100644 --- a/.github/workflows/issue-open.yml +++ b/.github/workflows/issue-open.yml @@ -13,4 +13,4 @@ jobs: if: ${{ !github.event.issue.pull_request }} with: actions: 'add-labels' - labels: '状态:待处理' \ No newline at end of file + labels: '🔔 Pending processing' \ No newline at end of file