Browse Source

Chore: refine issue templates (#630)

Loyalsoldier 4 years ago
parent
commit
08b0abe675
2 changed files with 101 additions and 46 deletions
  1. 49 23
      .github/ISSUE_TEMPLATE/bug_cn.md
  2. 52 23
      .github/ISSUE_TEMPLATE/bug_en.md

+ 49 - 23
.github/ISSUE_TEMPLATE/bug_cn.md

@@ -3,59 +3,85 @@ name: V2Ray 程序问题
 about: "提交一个 V2Ray 的程序问题报告。"
 ---
 
+<!--
 除非特殊情况,请完整填写所有问题。不按模板发的 issue 将直接被关闭。
-如果你遇到的问题不是 V2Ray 的 bug,比如你不清楚要如何配置,请使用[Discussion](https://github.com/v2fly/v2ray-core/discussions)进行讨论。
+如果你遇到的问题不是 V2Ray 的 bug,比如你不清楚如何配置,请在 https://github.com/v2fly/v2ray-core/discussions 进行讨论。
+-->
 
-1) 你正在使用哪个版本的 V2Ray?(如果服务器和客户端使用了不同版本,请注明)
+## 你正在使用哪个版本的 V2Ray?
 
-2) 你的使用场景是什么?比如使用 Chrome 通过 Socks/VMess 代理观看 YouTube 视频。
+<!-- 如果服务端和客户端使用了不同版本,请注明 -->
 
-3) 你看到的不正常的现象是什么?(请描述具体现象,比如访问超时,TLS 证书错误等)
 
-4) 你期待看到的正确表现是怎样的
+## 你的使用场景是什么
 
-5) 请附上你的配置(提交 Issue 前请隐藏服务器端IP地址)。
+<!-- 比如使用 Chrome 通过 Socks/VMess 代理观看 YouTube 视频 -->
 
-服务器端配置:
+
+## 你看到的异常现象是什么?
+
+<!-- 请描述具体现象,比如访问超时、TLS 证书错误等 -->
+
+
+## 你期待看到的正常表现是怎样的?
+
+
+
+## 请附上你的配置
+
+<!-- 提交 issue 前,请隐去服务器域名或 IP 地址 -->
+
+**服务端配置:**
 
 ```javascript
-    // 在这里附上服务器端配置文件
+// 在这里附上服务器端配置文件
+
 ```
 
-客户端配置:
+**客户端配置:**
 
 ```javascript
-    // 在这里附上客户端配置
+// 在这里附上客户端配置
+
 ```
 
-6)  请附上出错时软件输出的错误日志。在 Linux 中,日志通常在 `/var/log/v2ray/error.log` 文件中。
+## 请附上出错时软件输出的错误日志
+
+<!-- 在 Linux 中,日志通常在 `/var/log/v2ray/error.log` 文件中 -->
 
-服务器端错误日志:
+**服务器端错误日志:**
 
 ```javascript
-    // 在这里附上服务器端日志
+// 在这里附上服务器端日志
+
 ```
 
-客户端错误日志:
+**客户端错误日志:**
 
 ```javascript
-    // 在这里附上客户端日志
+// 在这里附上客户端日志
+
 ```
 
-7) 请附上访问日志。在 Linux 中,日志通常在 `/var/log/v2ray/access.log` 文件中。
+## 请附上访问日志
+
+<!-- 在 Linux 中,访问日志通常在 `/var/log/v2ray/access.log` 文件中 -->
 
 ```javascript
-    // 在这里附上服务器端日志
+// 在这里附上服务器端日志
+
 ```
 
-8) 其它相关的配置文件(如 Nginx)和相关日志。
+## 其它相关的配置文件(如 Nginx)和相关日志
+
+
+
+## 如果 V2Ray 无法启动,请附上 `--test` 命令的输出
 
-9) 如果 V2Ray 无法启动,请附上 `--test` 输出。
 
-通常的命令为 `/usr/bin/v2ray/v2ray --test --config /etc/v2ray/config.json`。请按实际情况修改。
 
-10) 如果 V2Ray 服务运行不正常,请附上 journal 日志。
+## 如果 V2Ray 服务运行异常,请附上 journal 日志
 
-通常的命令为 `journalctl -u v2ray`。
+<!-- 通常的命令为 `journalctl -u v2ray` -->
 
-请预览一下你填的内容再提交。
+<!-- 请预览一下你填写的内容并整理好格式后,再提交 -->

+ 52 - 23
.github/ISSUE_TEMPLATE/bug_en.md

@@ -3,59 +3,88 @@ name: Bug report
 about: "Create a bug report to help us improve"
 ---
 
+<!--
 Please answer all the questions with enough information. All issues not following this template will be closed immediately.
-If you are not sure if your question is truely a bug in V2Ray, please discuss it [here](https://github.com/v2fly/v2ray-core/discussions) first.
+If you are not sure if your question is truely a bug of V2Ray, please discuss it at https://github.com/v2fly/v2ray-core/discussions first.
+-->
 
-1) What version of V2Ray are you using (If you deploy different version on server and client, please explicitly point out)?
+## What version of V2Ray are you using?
 
-2) What's your scenario of using V2Ray? E.g., Watching YouTube videos in Chrome via Socks/VMess proxy.
+<!-- If you deploy different versions of V2Ray on server and client, please explicitly point out -->
 
-3) What did you see? (Please describe in detail, such as timeout, fake TLS certificate etc)
 
-4) What's your expectation?
+## What's your scenario of using V2Ray?
 
-5) Please attach your configuration file (**Mask IP addresses before submit this issue**).
+<!-- E.g., watching YouTube videos in browsers via Socks/VMess proxy -->
 
-Server configuration:
+
+## What problems have you encountered?
+
+<!-- Please describe in detail, such as timeout, fake TLS certificate, etc -->
+
+
+## What's your expectation?
+
+
+
+## Please attach your configuration here
+
+<!-- Remember to mask your IP address or hostname -->
+
+**Server configuration:**
 
 ```javascript
-    // Please attach your server configuration here.
+// Please attach your server configuration here.
+
 ```
 
-Client configuration:
+**Client configuration:**
 
 ```javascript
-    // Please attach your client configuration here.
+// Please attach your client configuration here.
+
 ```
 
-6) Please attach error logs, especially the bottom lines if the file is large. Error log file is usually at `/var/log/v2ray/error.log` on Linux.
+## Please attach error logs here
+
+<!--
+only trailing lines if the log file is large in size.
+Error log file is usually at `/var/log/v2ray/error.log` on Linux.
+-->
 
-Server error log:
+**Server error log:**
 
 ```javascript
-    // Please attach your server error log here.
+// Please attach your server error log here.
+
 ```
 
-Client error log:
+**Client error log:**
 
 ```javascript
-    // Please attach your client error log here.
+// Please attach your client error log here.
+
 ```
 
-7) Please attach access log. Access log is usually at '/var/log/v2ray/access.log' on Linux.
+## Please attach access log here
+
+<!-- Access log is usually at '/var/log/v2ray/access.log' on Linux. -->
 
 ```javascript
-    // Please attach your server access log here.
+// Please attach your server access log here.
+
 ```
 
-8) Other configurations (such as Nginx) and logs.
+## Other configurations (such as Nginx) and logs here
+
+
+
+## If V2Ray cannot start up, please attach output from `--test` command
 
-9) If V2Ray doesn't run, please attach output from `--test`.
 
-The command is usually `/usr/bin/v2ray/v2ray --test --config /etc/v2ray/config.json`, but may vary according to your scenario.
 
-10) If V2Ray service doesn't run, please attach journal log.
+## If V2Ray service is abnormal, please attach journal log here
 
-Usual command is `journalctl -u v2ray`.
+<!-- Usual command is `journalctl -u v2ray` -->
 
-Please review your issue before submitting.
+<!-- Please review your issue and check the format before submitting. -->