Skip to content

Commit

Permalink
chore: add issue templates for bug reports and feature requests
Browse files Browse the repository at this point in the history
  • Loading branch information
Bush2021 committed Oct 30, 2024
1 parent 603b5e9 commit f44236b
Show file tree
Hide file tree
Showing 5 changed files with 102 additions and 1 deletion.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Bug Report
description: "Report Chrome++ Bug"
title: "[Bug] "
body:
- type: checkboxes
id: ensure
attributes:
label: Verify steps
description: Before submitting, please check the following applicable options to prove that you have read and understood the following requirements, otherwise the issue will be closed.
options:
- label: I have carefully read the [INI configuration file](https://github.com/Bush2021/chrome_plus/blob/main/src/chrome%2B%2B.ini) and understand the function of each configuration item.
required: true
- label: I have not searched for the problem I want to raise in the [Issue Tracker](https://github.com/Bush2021/chrome_plus/issues).
required: false
- label: I have provided the simplest configuration that can be used to reproduce the error I reported.
required: true
- label: I make sure to describe the problem in English.
required: true

- type: textarea
attributes:
label: Version Information
description: Please provide a screenshot of `chrome://version/`.
validations:
required: true
- type: textarea
attributes:
render: yaml
label: Configuration File
description: Please paste the simplest `chrome++.ini` content used to reproduce the problem.
validations:
required: true
- type: textarea
attributes:
label: Description
description: Please provide a detailed description of the error and the steps to reproduce the error.
validations:
required: true
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report_zh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: 错误反馈
description: "提交 Chrome++ Bug"
title: "[Bug] "
body:
- type: checkboxes
id: ensure
attributes:
label: 验证步骤
description: 在提交之前,请勾选以下适用选项以证明您已经阅读并理解了以下要求,否则该 issue 将被关闭。
options:
- label: 我仔细看过 [INI 配置文件](https://github.com/Bush2021/chrome_plus/blob/main/src/chrome%2B%2B.ini) 并理解了每个配置项的作用。
required: true
- label: 我未在 [Issue Tracker](https://github.com/Bush2021/chrome_plus/issues) 中寻找过我要提出的问题。
required: false
- label: 我提供了可用于重现我报告的错误的最简配置。
required: true
- label: 我确保使用中文描述问题。
required: true

- type: textarea
attributes:
label: 版本信息
description: 请提供 `chrome://version/` 的截图。
validations:
required: true
- type: textarea
attributes:
render: yaml
label: 配置文件
description: 请粘贴用于复现问题的最简 `chrome++.ini` 内容。
validations:
required: true
- type: textarea
attributes:
label: 描述
description: 请提供错误的详细描述以及重现错误的步骤
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Feature Request
description: Suggest improvements for this project
title: "[Feature] "
body:
- type: checkboxes
id: ensure
attributes:
label: Verification Steps
description: Before submitting, please check the following applicable options to prove that you have read and understood the following requirements, otherwise the issue will be closed.
options:
- label: I have carefully read the [INI configuration file](https://github.com/Bush2021/chrome_plus/blob/main/src/chrome%2B%2B.ini) and understand the function of each configuration item.
required: true
- label: I have not searched for the feature request I want to propose in the [Issue Tracker](https://github.com/Bush2021/chrome_plus/issues) and did not find it.
required: true
- label: I am willing to create a pull request to implement the feature I proposed, otherwise I understand that the issue is likely to be closed.
required: true
- label: I make sure to describe the feature in English.
required: true
- type: textarea
attributes:
label: Description
description: Please provide a detailed description of the feature, rather than vague statements.
validations:
required: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The key is to ensure that `version.dll` is placed in the same directory as `chro
## Compatibility
* All browsers based on the latest stable branches of Chromium are theoretically supported.
* Only the latest stable version of Chrome is tested, and maintenance is not guaranteed.
* If the DLL is not properly loaded, try to [set DLL] (https://github.com/Bush2021/chrome_plus/blob/main/setdll/).
* If the DLL is not properly loaded, try to [set DLL](https://github.com/Bush2021/chrome_plus/blob/main/setdll/).

## License
* Versions 1.5.4 and earlier are licensed under MIT license, with all rights reserved by [Shuax](https://github.com/shuax/).
Expand Down

0 comments on commit f44236b

Please sign in to comment.