diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..cca3953 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +How to contribute +================= + +Before you submit issues, please take a few minutes to read this guide. + +在你提交问题前,请花两分钟阅读一下这份指南。 + +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? +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. +6. Any other useful information. + +Skip any of them if you don't know its meaning. + +问题反馈 +------- + +请提交下面的信息: + +1. 你是如何搭建环境的?(操作系统,Shadowsocks 版本) +2. 错误是发生在哪里,本地还是服务器? +3. 浏览器里的现象是什么?一直转菊花,还是有提示错误? +4. 发生错误时,本地端的十行完整的日志。 +5. 发生错误时,服务器端的十行完整的日志。 +6. 其它你认为可能和问题有关的信息。 + +如果你不清楚其中某条的含义, 可以直接跳过那一条。