Add: Issue templates

This commit is contained in:
JimhHan 2021-03-06 21:06:58 +08:00
parent 29db059a87
commit 039c8e63e7
No known key found for this signature in database
GPG key ID: 48D5D7CF95157AC5
6 changed files with 198 additions and 6 deletions

91
.github/ISSUE_TEMPLATE/bug-en.md vendored Normal file
View file

@ -0,0 +1,91 @@
---
name: Bug Report
about: Create a bug report of Xray.
title: '[Bug] <bug you are reporting>'
labels: ''
assignees: ''
---
<!-- Thanks for your reporting.
1. This issue is used to submit a bug of Xray. If you are not sure, please give feedback in the group.
2. Please check the existing issues, discussions and documentation in detail. Issue which report a known bug may be closed.
3. Please don't report issue like "I can't use a feature". It's probably your fault.
4. You should fully complete the following contents.
5. Make sure that ALL of private information is covered up.
-->
**Describe the bug**
<!-- A clear and concise description of what the bug is. -->
**To Reproduce**
<!-- Steps to reproduce the behavior: -->
1.
2.
3.
4.
**Expected behavior**
<!-- A clear and concise description of what you expected to happen. -->
**Client Log**
<details>
```
Please paste your client log here:
```
</details>
**Server Log**
<details>
```
Please paste your server log here:
```
</details>
**Client config**
<details>
```json
Please paste your client config file here:
```
</details>
**Server Config**
<details>
```json
Please paste your server config file here:
```
</details>
**Client Information**
- OS: [e.g. Windows 10]
- Xray version [e.g. 1.3.1]
- Xray installing approach[e.g. Xray-install]
**Server Information**
- OS: [e.g. Windows 10]
- Xray version [e.g. 1.3.1]
- Xray installing approach[e.g. Xray-install]
**Additional Information**
<!-- Add any other information about the problem here. -->

View file

@ -1,7 +1,7 @@
--- ---
name: Bug 反馈 name: Bug 反馈
about: 这是xray的一个bug。 about: 这是 Xray 的一个 bug。
title: '' title: '[Bug] 你发现的bug'
labels: '' labels: ''
assignees: '' assignees: ''
@ -9,10 +9,11 @@ assignees: ''
<!-- 感谢您的反馈! <!-- 感谢您的反馈!
1. 请先确认您提交的是 xray 的 Bug而非使用咨询。如果您不确定请在群中反馈。 1. 请先确认您提交的是 xray 的 Bug而非使用咨询。如果您不确定请在群中反馈。
2. 请先查询已有的issue并且详细阅读文档的相关内容。如果您提出的是已知的问题此 issue 将有可能被关闭。 2. Bug软件运行中因为 **程序本身有错误** 而造成的功能不正常。(Reference: Wikipedia)
3. 请不要轻易提出类似“不能使用某功能”的问题。这往往是配置文件错误。 3. 请先查询已有的 issue 与 discussion ,并且详细阅读文档的相关内容。如果您提出的是已知的问题,此 issue 将有可能被关闭。
4. 您需要完整地完成下列内容,否则此 issue 可能不会被处理。除非您清楚您在做什么。 4. 请不要轻易提出类似“不能使用某功能”的问题。这往往是配置文件错误。
5. 请 *务必* 打码域名、密码和 Path 等隐私信息。 5. 您需要完整地完成下列内容,否则此 issue 可能不会被处理。
6. 请 *务必* 打码域名、密码和 Path 等隐私信息。
--> -->
**问题描述** **问题描述**
@ -79,10 +80,12 @@ assignees: ''
**客户端环境** **客户端环境**
- 系统与版本: [如 Windows 10] - 系统与版本: [如 Windows 10]
- Xray 版本 [如 1.3.1] - Xray 版本 [如 1.3.1]
- Xray 安装方式:[如 Xray-install]
**服务端环境** **服务端环境**
- 系统与版本: [如 Windows 10] - 系统与版本: [如 Windows 10]
- Xray 版本 [如 1.3.1] - Xray 版本 [如 1.3.1]
- Xray 安装方式:[如 Xray-install]
**附加信息** **附加信息**
<!-- 如果您有额外的信息,请在此处说明。--> <!-- 如果您有额外的信息,请在此处说明。-->

32
.github/ISSUE_TEMPLATE/feature-en.md vendored Normal file
View file

@ -0,0 +1,32 @@
---
name: Feature Request
about: Suggest an idea for Xray
title: '[Feature] your idea'
labels: ''
assignees: ''
---
<!-- Thanks for your supporting!
1. Please confirm that you are submitting a feature request。
2. We do not recommend any inexperienced users to request new feature.
3. Please check the existing issues, discussions and documentation in detail. Duplicated issue may be closed.
4. To be clear: none of developers is obliged to meet your needs. In particular, features that do not make any sense.
5. You should fully complete the following contents.
-->
**What's your idea**
<!-- A clear and concise description of your idea. -->
**Is it related to an issue?**
<!-- Please specify here if yes. -->
**What's your solution?**
<!-- Describe the solution you'd like. -->
1.
2.
3.
4.
**Is there any additional information?**
<!-- Add any other information here. -->

32
.github/ISSUE_TEMPLATE/feature-zh-CN.md vendored Normal file
View file

@ -0,0 +1,32 @@
---
name: 功能请求
about: 希望 Xray 添加一个新功能。
title: '[Feature] 你的想法'
labels: ''
assignees: ''
---
<!-- 感谢您的反馈!
1. 请先确认您提交的是功能请求。
2. 我们不建议缺少经验的用户提出功能请求。如果您执意提出,请使用 tg 群组。
3. 请先查询已有的 issue 与 discussion ,并且详细阅读文档的相关内容。重复的功能请求将有可能被关闭。
4. 需要向您明确一点:任何开发者均没有义务满足您的需求。特别是不合理或没有意义的功能。
5. 您需要完整地完成下列内容,否则此 issue 可能不会被处理。
-->
**您的想法是什么?**
<!-- 请清晰简洁地描述您预期中的功能。-->
**是否与已知的 issue 相关?**
<!-- 如果是,请在此注明 -->
**您认为应如何实现此功能?**
<!-- 请清晰简洁地描述如何实现此功能。-->
1.
2.
3.
4.
**有没有额外的信息?**
<!-- 如果您有额外的信息,请在此处说明。-->

17
.github/ISSUE_TEMPLATE/question-en.md vendored Normal file
View file

@ -0,0 +1,17 @@
---
name: Question
about: Question of Xray.
title: ''
labels: ''
assignees: ''
---
<!-- Thanks for your supporting
1. This isn't a proper place to aks question, otherwise your issue may be closed.
2. Please check the existing issues, discussions and documentation in detail. You may find the answers you need there.
3. If it is still not resolved, please give feedback in the tg group or discussion.
4. Wherever you ask a question, please *make sure* to cover every private information.
5. We highly recommend you to read https://github.com/tvvocold/How-To-Ask-Questions-The-Smart-Way.
-->

View file

@ -0,0 +1,17 @@
---
name: 使用疑问
about: 使用 Xray 时的疑问。
title: ''
labels: ''
assignees: ''
---
<!-- 感谢您的支持!
1. 我们十分理解您的急切之情。但是,这里**不是**用来提问的。
2. 请先查询已有的 issue、discussion ,并且详细阅读文档的相关内容。那里可能有您需要的答案。
3. 如果仍未解决,请在 tg 群中或 discussion 区反馈。请不要使用 Issue 反馈,否则将可能会被 close。
4. 无论在何处提问,请 *务必* 打码域名、密码和 Path 等隐私信息。
5. 我们强烈推荐您阅读 https://github.com/tvvocold/How-To-Ask-Questions-The-Smart-Way。
-->