diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0c67d39c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +## How to Contribute + +### Report an issue + +In case of any encountered problem, always check your network status first. That is, please ensure the video you want to download can be streamed properly in your web browser. + +* Keep in mind that some videos on some hosting sites may have a region restriction, e.g., Youku is blocking access to some videos from IP addresses outside mainland China, and YouTube is also blocking some videos in Germany. + +Please include: + +* Your exact command line, like `you-get -i "www.youtube.com/watch?v=sGwy8DsUJ4M"`. A common mistake is not to escape the `&`. Putting URLs in quotes should solve this problem. + +* Your full console output. + +* If you executed the command and got no response, please re-run the command with `--debug`, kill the process with keyboard shortcut `Ctrl-C` and include the full console output. + +* The output of `you-get --version`, or `git rev-parse HEAD` -- if you are using a Git version (but always remember to keep up-to-date!) + +* The output of `python --version`. + +* If possible, you may include your IP address and proxy setting information as well. + +### Send me a pull request + +My time for maintaining this stuff is very limited. If you really want to have support for some site that has not yet been implemented, the best way is to fix it yourself and send me a pull request. diff --git a/README.md b/README.md index 2859ac59..b0bdb208 100644 --- a/README.md +++ b/README.md @@ -178,6 +178,10 @@ See source code. You-Get is licensed under the [MIT license](https://raw.github.com/soimort/you-get/master/LICENSE.txt). +## Contributing + +Please see [CONTRIBUTING.md](https://raw.github.com/soimort/you-get/master/CONTRIBUTING.md). + *** @@ -375,3 +379,7 @@ YouTube等国外视频网站的下载,请移步:[rg3/youtube-dl](https://git ## 许可证 You-Get在[MIT License](https://raw.github.com/soimort/you-get/master/LICENSE.txt)下发布。 + +## 如何参与贡献 / 报告issue + +请阅读 [CONTRIBUTING.md](https://raw.github.com/soimort/you-get/master/CONTRIBUTING.md)。