diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c0c767..11054e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,25 @@ How to contribute ================= +在你提交问题前,请先[自行诊断]一下。提交时附上诊断过程中的问题和下列结果, +否则如果我们无法重现你的问题,也就不能帮助你。 + Before you submit issues, please read [Troubleshooting] and take a few minutes to read this guide. -在你提交问题前,请先[自行诊断]一下,然后再提交,附上诊断过程中的问题和下列结果, -否则我们无法重现你的问题,也就帮不了你。 +问题反馈 +------- + +请提交下面的信息: + +1. 你是如何搭建环境的?(操作系统,Shadowsocks 版本) +2. 有无错误提示?错误是发生在哪里,客户端还是服务器? +3. 浏览器里的现象是什么?一直转菊花,还是有提示错误? +4. 发生错误时,客户端最后一页完整的日志。 +5. 发生错误时,服务器端最后一页完整的日志。 +6. 其它你认为可能和问题有关的信息。 + +如果你不清楚其中某条的含义, 可以直接跳过那一条。 Issues ------ @@ -21,19 +35,5 @@ Please include the following information in your submission: Skip any of them if you don't know its meaning. -问题反馈 -------- - -请提交下面的信息: - -1. 你是如何搭建环境的?(操作系统,Shadowsocks 版本) -2. 有无错误提示?错误是发生在哪里,客户端还是服务器? -3. 浏览器里的现象是什么?一直转菊花,还是有提示错误? -4. 发生错误时,客户端最后一页完整的日志。 -5. 发生错误时,服务器端最后一页完整的日志。 -6. 其它你认为可能和问题有关的信息。 - -如果你不清楚其中某条的含义, 可以直接跳过那一条。 - [Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting [自行诊断]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting