mirror of
https://github.com/soimort/you-get.git
synced 2025-01-23 05:25:02 +03:00
update CONTRIBUTING.md
This commit is contained in:
parent
dca9897b8a
commit
6563bd60c0
39
.github/ISSUE_TEMPLATE.md
vendored
39
.github/ISSUE_TEMPLATE.md
vendored
@ -1,39 +0,0 @@
|
|||||||
Please make sure these boxes are checked before submitting your issue – thank you!
|
|
||||||
|
|
||||||
- [ ] You can actually watch the video in your browser or mobile application, but not download them with `you-get`.
|
|
||||||
- [ ] Your `you-get` is up-to-date.
|
|
||||||
- [ ] I have read <https://github.com/soimort/you-get/wiki/FAQ> and tried to do so.
|
|
||||||
- [ ] The issue is not yet reported on <https://github.com/soimort/you-get/issues> or <https://github.com/soimort/you-get/wiki/Known-Bugs>. If so, please add your comments under the existing issue.
|
|
||||||
- [ ] The issue (or question) is really about `you-get`, not about some other code or project.
|
|
||||||
|
|
||||||
Run the command with the `--debug` option, and paste the full output inside the fences:
|
|
||||||
|
|
||||||
```
|
|
||||||
[PASTE IN ME]
|
|
||||||
```
|
|
||||||
|
|
||||||
If there's anything else you would like to say (e.g. in case your issue is not about downloading a specific video; it might as well be a general discussion or proposal for a new feature), fill in the box below; otherwise, you may want to post an emoji or meme instead:
|
|
||||||
|
|
||||||
> [WRITE SOMETHING]
|
|
||||||
> [OR HAVE SOME :icecream:!]
|
|
||||||
|
|
||||||
汉语翻译最终日期:2016年02月26日
|
|
||||||
|
|
||||||
在提交前,请确保您已经检查了以下内容!
|
|
||||||
|
|
||||||
- [ ] 你可以在浏览器或移动端中观看视频,但不能使用`you-get`下载.
|
|
||||||
- [ ] 您的`you-get`为最新版.
|
|
||||||
- [ ] 我已经阅读并按 <https://github.com/soimort/you-get/wiki/FAQ> 中的指引进行了操作.
|
|
||||||
- [ ] 您的问题没有在<https://github.com/soimort/you-get/issues> , <https://github.com/soimort/you-get/wiki/FAQ> 或 <https://github.com/soimort/you-get/wiki/Known-Bugs> 报告,否则请在原有issue下报告.
|
|
||||||
- [ ] 本问题确实关于`you-get`, 而不是其他项目.
|
|
||||||
|
|
||||||
请使用`--debug`运行,并将输出粘贴在下面:
|
|
||||||
|
|
||||||
```
|
|
||||||
[在这里粘贴完整日志]
|
|
||||||
```
|
|
||||||
|
|
||||||
如果您有其他附言,例如问题只在某个视频发生,或者是一般性讨论或者提出新功能,请在下面添加;或者您可以卖个萌:
|
|
||||||
|
|
||||||
> [您的内容]
|
|
||||||
> [舔 :icecream:!]
|
|
48
.github/PULL_REQUEST_TEMPLATE.md
vendored
48
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,48 +0,0 @@
|
|||||||
**(PLEASE DELETE ALL THESE AFTER READING)**
|
|
||||||
|
|
||||||
Thank you for the pull request! `you-get` is a growing open source project, which would not have been possible without contributors like you.
|
|
||||||
|
|
||||||
Here are some simple rules to follow, please recheck them before sending the pull request:
|
|
||||||
|
|
||||||
- [ ] If you want to propose two or more unrelated patches, please open separate pull requests for them, instead of one;
|
|
||||||
- [ ] All pull requests should be based upon the latest `develop` branch;
|
|
||||||
- [ ] Name your branch (from which you will send the pull request) properly; use a meaningful name like `add-this-shining-feature` rather than just `develop`;
|
|
||||||
- [ ] All commit messages, as well as comments in code, should be written in understandable English.
|
|
||||||
|
|
||||||
As a contributor, you must be aware that
|
|
||||||
|
|
||||||
- [ ] You agree to contribute your code to this project, under the terms of the MIT license, so that any person may freely use or redistribute them; of course, you will still reserve the copyright for your own authorship.
|
|
||||||
- [ ] You may not contribute any code not authored by yourself, unless they are licensed under either public domain or the MIT license, literally.
|
|
||||||
|
|
||||||
Not all pull requests can eventually be merged. I consider merged / unmerged patches as equally important for the community: as long as you think a patch would be helpful, someone else might find it helpful, too, therefore they could take your fork and benefit in some way. In any case, I would like to thank you in advance for taking your time to contribute to this project.
|
|
||||||
|
|
||||||
Cheers,
|
|
||||||
Mort
|
|
||||||
|
|
||||||
**(PLEASE REPLACE ALL ABOVE WITH A DETAILED DESCRIPTION OF YOUR PULL REQUEST)**
|
|
||||||
|
|
||||||
|
|
||||||
汉语翻译最后日期:2016年02月26日
|
|
||||||
|
|
||||||
**(阅读后请删除所有内容)**
|
|
||||||
|
|
||||||
感谢您的pull request! `you-get`是稳健成长的开源项目,感谢您的贡献.
|
|
||||||
|
|
||||||
以下简单检查项目望您复查:
|
|
||||||
|
|
||||||
- [ ] 如果您预计提出两个或更多不相关补丁,请为每个使用不同的pull requests,而不是单一;
|
|
||||||
- [ ] 所有的pull requests应基于最新的`develop`分支;
|
|
||||||
- [ ] 您预计提出pull requests的分支应有有意义名称,例如`add-this-shining-feature`而不是`develop`;
|
|
||||||
- [ ] 所有的提交信息与代码中注释应使用可理解的英语.
|
|
||||||
|
|
||||||
作为贡献者,您需要知悉
|
|
||||||
|
|
||||||
- [ ] 您同意在MIT协议下贡献代码,以便任何人自由使用或分发;当然,你仍旧保留代码的著作权
|
|
||||||
- [ ] 你不得贡献非自己编写的代码,除非其属于公有领域或使用MIT协议.
|
|
||||||
|
|
||||||
不是所有的pull requests都会被合并,然而我认为合并/不合并的补丁一样重要:如果您认为补丁重要,其他人也有可能这么认为,那么他们可以从你的fork中提取工作并获益。无论如何,感谢您费心对本项目贡献.
|
|
||||||
|
|
||||||
祝好,
|
|
||||||
Mort
|
|
||||||
|
|
||||||
**(请将本内容完整替换为PULL REQUEST的详细内容)**
|
|
@ -1,27 +1,27 @@
|
|||||||
# How to Contribute
|
# How to Report an Issue
|
||||||
|
|
||||||
`you-get` is currently experimenting with an aggressive approach to handling issues. Namely, a bug report must be addressed with some code via a pull request.
|
If you would like to report a problem you find when using `you-get`, please open a [Pull Request](https://github.com/soimort/you-get/pulls), which should include:
|
||||||
|
|
||||||
## Report a broken extractor
|
1. A detailed description of the encountered problem;
|
||||||
|
2. At least one commit, addressing the problem through some unit test(s).
|
||||||
|
* Examples of good commits: [#2675](https://github.com/soimort/you-get/pull/2675/files), [#2680](https://github.com/soimort/you-get/pull/2680/files), [#2685](https://github.com/soimort/you-get/pull/2685/files)
|
||||||
|
|
||||||
**How-To:** Please open a new pull request with the following changes:
|
PRs that fail to meet the above criteria may be closed summarily with no further action.
|
||||||
|
|
||||||
* Add a new test case in [tests/test.py](https://github.com/soimort/you-get/blob/develop/tests/test.py), with the failing URL(s).
|
A valid PR will remain open until its addressed problem is fixed.
|
||||||
|
|
||||||
The Travis CI build will (ideally) fail showing a :x:, which means you have successfully reported a broken extractor.
|
|
||||||
|
|
||||||
Such a valid PR will be either *closed* if it's fixed by another PR, or *merged* if it's fixed by follow-up commits from the reporter himself/herself.
|
|
||||||
|
|
||||||
## Report other issues / Suggest a new feature
|
# 如何汇报问题
|
||||||
|
|
||||||
**How-To:** Please open a pull request with the proposed changes directly.
|
为了防止对 GitHub Issues 的滥用,本项目不接受一般的 Issue。
|
||||||
|
|
||||||
A valid PR need not be complete (i.e., can be WIP), but it should contain at least one sensible, nontrivial commit.
|
如您在使用 `you-get` 的过程中发现任何问题,请开启一个 [Pull Request](https://github.com/soimort/you-get/pulls)。该 PR 应当包含:
|
||||||
|
|
||||||
## Hints
|
1. 详细的问题描述;
|
||||||
|
2. 至少一个 commit,其内容是**与问题相关的**单元测试。**不要通过随意修改无关文件的方式来提交 PR!**
|
||||||
|
* 有效的 commit 示例:[#2675](https://github.com/soimort/you-get/pull/2675/files), [#2680](https://github.com/soimort/you-get/pull/2680/files), [#2685](https://github.com/soimort/you-get/pull/2685/files)
|
||||||
|
|
||||||
* The [`develop`](https://github.com/soimort/you-get/tree/develop) branch is where your pull request goes.
|
不符合以上条件的 PR 可能被直接关闭。
|
||||||
* Remember to rebase.
|
|
||||||
* Document your PR clearly, and if applicable, provide some sample links for reviewers to test with.
|
有效的 PR 将会被一直保留,直至相应的问题得以修复。
|
||||||
* Write well-formatted, easy-to-understand commit messages. If you don't know how, look at existing ones.
|
|
||||||
* We will not ask you to sign a CLA, but you must assure that your code can be legally redistributed (under the terms of the MIT license).
|
|
||||||
|
@ -4,6 +4,10 @@
|
|||||||
[![Build Status](https://travis-ci.org/soimort/you-get.svg)](https://travis-ci.org/soimort/you-get)
|
[![Build Status](https://travis-ci.org/soimort/you-get.svg)](https://travis-ci.org/soimort/you-get)
|
||||||
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/soimort/you-get?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
|
|
||||||
|
**NOTICE: Read [this](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md) if you are looking for the conventional "Issues" tab.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
[You-Get](https://you-get.org/) is a tiny command-line utility to download media contents (videos, audios, images) from the Web, in case there is no other handy way to do it.
|
[You-Get](https://you-get.org/) is a tiny command-line utility to download media contents (videos, audios, images) from the Web, in case there is no other handy way to do it.
|
||||||
|
|
||||||
Here's how you use `you-get` to download a video from [YouTube](https://www.youtube.com/watch?v=jNQXAC9IVRw):
|
Here's how you use `you-get` to download a video from [YouTube](https://www.youtube.com/watch?v=jNQXAC9IVRw):
|
||||||
@ -448,7 +452,7 @@ For all other sites not on the list, the universal extractor will take care of f
|
|||||||
|
|
||||||
If something is broken and `you-get` can't get you things you want, don't panic. (Yes, this happens all the time!)
|
If something is broken and `you-get` can't get you things you want, don't panic. (Yes, this happens all the time!)
|
||||||
|
|
||||||
Check if it's already a known problem on <https://github.com/soimort/you-get/wiki/Known-Bugs>. If not, follow the guidelines on [how to report a broken extractor](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md#report-a-broken-extractor).
|
Check if it's already a known problem on <https://github.com/soimort/you-get/wiki/Known-Bugs>. If not, follow the guidelines on [how to report an issue](https://github.com/soimort/you-get/blob/develop/CONTRIBUTING.md).
|
||||||
|
|
||||||
## Getting Involved
|
## Getting Involved
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user