Skip to content

Commit

Permalink
add: issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
XZB-1248 committed Jun 18, 2022
1 parent 44836c2 commit 50d3273
Show file tree
Hide file tree
Showing 6 changed files with 106 additions and 14 deletions.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "[BUG Report]"
description: To file a bug report.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to help us improve our project, please **do confirm that your issue is not duplicate and not because of your operation or version issues**.
感谢您花时间帮我们完善项目,请**务必确认您的issue不与他人重复且问题不是由于您的操作和版本问题造成的**。
- type: checkboxes
attributes:
label: Please make sure of the following things.
description: You may select more than one, even select all.
options:
- label: I have read the [documentation](https://github.com/XZB-1248/Spark/blob/master/README.md).
- label: 我已阅读 [文档](https://github.com/XZB-1248/Spark/blob/master/README.ZH.md)。
- label: I'm sure there are no duplicate issues.
- label: 我确定没有提交和他人重复的issue。
- label: I'm sure it's due to **Spark** itself and not my operational issue or something else.
- label: 我确定问题由**Spark**自身引起,不是我自己的操作失误或其他问题。
- type: input
id: version
attributes:
label: Version / 版本
description: What version of our software are you running?
placeholder: v0.1.1
validations:
required: true
- type: textarea
id: description
attributes:
label: Describe the bug / 问题描述
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction / 复现方式
description: |
Please provide a way to reproduce the problem.
请提供问题的复现方式或操作步骤。
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs / 日志
description: |
Please paste output, error info or screenshot here.
请把相关的输出、错误日志或者截图粘贴到此处。
render: shell
- type: textarea
id: additional
attributes:
label: Additional information / 附加说明
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
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: "[Feature Request]"
description: To file a feature request.
labels: [enhancement]
body:
- type: checkboxes
attributes:
label: Please make sure of the following things.
description: You may select more than one, even select all.
options:
- label: I have read the [documentation](https://github.com/XZB-1248/Spark/blob/master/README.md).
- label: 我已阅读 [文档](https://github.com/XZB-1248/Spark/blob/master/README.ZH.md)。
- label: I'm sure there are no duplicate issues.
- label: 我确定没有提交和他人重复的issue。
- label: I'm sure this feature is not implemented.
- label: 我确定该功能尚未实现。
- label: I'm sure it's a reasonable and popular requirement.
- label: 我确定这个需求合理且符合大多数人需要。
- type: textarea
id: description
attributes:
label: Describe the feature / 需求描述
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested solution / 实现思路
description: |
Solutions to achieve this requirement.
实现此需求的解决思路。
- type: textarea
id: additional
attributes:
label: Additional information / 附加说明
13 changes: 7 additions & 6 deletions README.ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,20 @@
### 本地安装

*[Releases](https://github.com/XZB-1248/Spark/releases) 页面下载对应系统的可执行文件。
* 解压文件,**不要删除**`built`文件夹。
* 在目录下创建一个名为`Config.json`的配置文件,修改其中的信息。

```json
{
"listen": ":8000",
"salt": "some random string",
"auth": {
"username": "password"
}
"listen": ":8000",
"salt": "some random string",
"auth": {
"username": "password"
}
}
```

* 修改完成后运行服务端,然后打开 IP:端口。
* 修改完成后运行服务端,然后打开 IP:端口,例如 `http://localhost:8000/`
* 在管理页面中生成客户端,并部署到设备上。
* 现在就可以控制这个设备了。

Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,20 @@ Only local installation are available yet.

### Local installation
* Get prebuilt executable file from [Releases](https://github.com/XZB-1248/Spark/releases) page.
* Extract all files and **do not** delete `built` directory.
* Create a configuration file named `Config.json` and set your own salt.

```json
{
"listen": ":8000",
"salt": "some random string",
"auth": {
"username": "password"
}
"listen": ":8000",
"salt": "some random string",
"auth": {
"username": "password"
}
}
```

* Run it and browse the address:port you've just set.
* Run it and browse the address:port you've just set, for example: `http://localhost:8000/`.
* Generate client online and execute it on your device.
* Now you can control your device.

Expand Down
4 changes: 2 additions & 2 deletions web/src/locale/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@
"downloadInvalidPath": "无法压缩磁盘分区",
"deleteMultiConfirm": "确定要删除这些项目吗?",
"deleteConfirm": "确定要删除该{0}吗?",
"deleteSuccess": "文件或目录已被删除",
"deleteSuccess": "文件或目录已删除",
"deleteInvalidPath": "无法删除磁盘分区",
"dateTimeFormat": "YYYY/MM/DD HH:mm",
"fileMultiSelectAlert": "已选择{0}项,总共{1}项",
"fileOrDirNotExist": "文件或目录不存在",
"fileOverwriteConfirm": "文件 [ {0} ] 已经存在,是否覆盖?",
"fileOverwriteConfirm": "文件[ {0} ]已经存在,是否覆盖?",
"fileOverwrite": "覆盖",
"fileTooLarge": "文件太大,读取失败",
"fileEncodingUnsupported": "不支持该文件编码",
Expand Down

0 comments on commit 50d3273

Please sign in to comment.