Update CONTRIBUTING.md
This commit is contained in:
parent
0bc0117cd7
commit
b12ba5383c
1 changed files with 16 additions and 27 deletions
|
@ -1,38 +1,27 @@
|
|||
How to contribute
|
||||
=================
|
||||
|
||||
在你提交问题前,请先[自行诊断]一下。提交时附上诊断过程中的问题和下列结果,
|
||||
否则如果我们无法重现你的问题,也就不能帮助你。
|
||||
Pull Requests
|
||||
-------------
|
||||
|
||||
Before you submit issues, please read [Troubleshooting] and take a few minutes
|
||||
to read this guide.
|
||||
|
||||
问题反馈
|
||||
-------
|
||||
|
||||
请提交下面的信息:
|
||||
|
||||
1. 你是如何搭建环境的?(操作系统,Shadowsocks 版本)
|
||||
2. 操作步骤是什么?
|
||||
3. 浏览器里的现象是什么?一直转菊花,还是有提示错误?
|
||||
4. 发生错误时,客户端和服务端最后一部分日志。
|
||||
5. 其它你认为可能和问题有关的信息。
|
||||
|
||||
如果你不清楚其中某条的含义, 可以直接跳过那一条。
|
||||
1. Pull requests are welcome. If you would like to add a large feature
|
||||
or make a significant change, make sure to open an issue to dicuss with
|
||||
people first.
|
||||
2. Follow PEP8.
|
||||
3. Make sure to pass the unit tests. Write unit tests for new modules if
|
||||
needed.
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
Please include the following information in your submission:
|
||||
1. Only bugs and feature requests are accepted here.
|
||||
2. We'll only work on important features. If the feature you're asking only
|
||||
benefits a few people, you'd better implement the feature yourself and send us
|
||||
a pull request, or ask some of your friends to do so.
|
||||
3. We don't answer questions of any other types here. Since very few people
|
||||
are watching the issue tracker here, you'll probably get no help from here.
|
||||
Read [Troubleshooting] and get help from forums or [mailing lists].
|
||||
|
||||
1. How did you set up your environment? (OS, version of Shadowsocks)
|
||||
2. Steps to reproduce the problem.
|
||||
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.
|
||||
|
||||
[Troubleshooting]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
|
||||
[自行诊断]: https://github.com/clowwindy/shadowsocks/wiki/Troubleshooting
|
||||
[mailing lists]: https://groups.google.com/forum/#!forum/shadowsocks
|
||||
|
|
Loading…
Reference in a new issue