you-get/CONTRIBUTING.md

28 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2019-03-09 01:17:28 +03:00
# How to Report an Issue
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
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:
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
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)
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
PRs that fail to meet the above criteria may be closed summarily with no further action.
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
A valid PR will remain open until its addressed problem is fixed.
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
# 如何汇报问题
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
为了防止对 GitHub Issues 的滥用,本项目不接受一般的 Issue。
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
如您在使用 `you-get` 的过程中发现任何问题,请开启一个 [Pull Request](https://github.com/soimort/you-get/pulls)。该 PR 应当包含:
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
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)
2017-11-28 01:43:12 +03:00
2019-03-09 01:17:28 +03:00
不符合以上条件的 PR 可能被直接关闭。
有效的 PR 将会被一直保留,直至相应的问题得以修复。