diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cca3953..4a73830 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,10 @@ How to contribute ================= -Before you submit issues, please take a few minutes to read this guide. +Before you submit issues, please read [Troubleshooting] and take a few minutes +to read this guide. -在你提交问题前,请花两分钟阅读一下这份指南。 +在你提交问题前,请先[自行诊断]一下,然后再提交,附上诊断过程中的问题和下列结果。 Issues ------ @@ -11,7 +12,7 @@ Issues Please include the following information in your submission: 1. How did you set up your environment? (OS, version of Shadowsocks) -2. Where did you see this error, was it on local or on server? +2. Did you see any error? Where did you see this error, was it on local or on server? 3. What happened in your browser? Just no response, or any error message? 4. 10 lines of log on the local side of shadowsocks when the error happened. 5. 10 lines of log on the server side of shadowsocks when the error happened. @@ -25,10 +26,13 @@ Skip any of them if you don't know its meaning. 请提交下面的信息: 1. 你是如何搭建环境的?(操作系统,Shadowsocks 版本) -2. 错误是发生在哪里,本地还是服务器? +2. 有无错误提示?错误是发生在哪里,客户端还是服务器? 3. 浏览器里的现象是什么?一直转菊花,还是有提示错误? -4. 发生错误时,本地端的十行完整的日志。 -5. 发生错误时,服务器端的十行完整的日志。 +4. 发生错误时,客户端最后一页完整的日志。 +5. 发生错误时,服务器端最后一页完整的日志。 6. 其它你认为可能和问题有关的信息。 如果你不清楚其中某条的含义, 可以直接跳过那一条。 + +[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting +[自行诊断]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting diff --git a/README.md b/README.md index 102b2b7..543f1a6 100644 --- a/README.md +++ b/README.md @@ -107,11 +107,10 @@ MIT Bugs and Issues ---------------- -Please visit [Issue Tracker] -Mailing list: http://groups.google.com/group/shadowsocks - -Also see [Troubleshooting] +* [Troubleshooting] +* [Issue Tracker] +* [Mailing list] [Android]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#android @@ -121,6 +120,7 @@ Also see [Troubleshooting] [GUI client]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients [iOS]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#ios [Issue Tracker]: https://github.com/clowwindy/shadowsocks/issues?state=open +[Mailing list]: http://groups.google.com/group/shadowsocks [OpenWRT]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#openwrt [OS X]: https://github.com/clowwindy/shadowsocks/wiki/Ports-and-Clients#os-x [PyPI]: https://pypi.python.org/pypi/shadowsocks