]> jfr.im git - yt-dlp.git/blob - .github/PULL_REQUEST_TEMPLATE.md
[doc] Minor improvements
[yt-dlp.git] / .github / PULL_REQUEST_TEMPLATE.md
1 <!--
2 # Please follow the guide below
3
4 - You will be asked some questions, please read them **carefully** and answer honestly
5 - Put an `x` into all the boxes `[ ]` relevant to your *pull request* (like [x])
6 - Use *Preview* tab to see how your *pull request* will actually look like
7
8 -->
9
10 ### Before submitting a *pull request* make sure you have:
11 - [ ] At least skimmed through [contributing guidelines](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions) including [yt-dlp coding conventions](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#yt-dlp-coding-conventions)
12 - [ ] [Searched](https://github.com/yt-dlp/yt-dlp/search?q=is%3Apr&type=Issues) the bugtracker for similar pull requests
13 - [ ] Checked the code with [flake8](https://pypi.python.org/pypi/flake8) and [ran relevant tests](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions)
14
15 ### In order to be accepted and merged into yt-dlp each piece of code must be in public domain or released under [Unlicense](http://unlicense.org/). Check one of the following options:
16 - [ ] I am the original author of this code and I am willing to release it under [Unlicense](http://unlicense.org/)
17 - [ ] I am not the original author of this code but it is in public domain or released under [Unlicense](http://unlicense.org/) (provide reliable evidence)
18
19 ### What is the purpose of your *pull request*?
20 - [ ] Fix or improvement to an extractor (Make sure to add/update tests)
21 - [ ] New extractor ([Piracy websites will not be accepted](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#is-the-website-primarily-used-for-piracy))
22 - [ ] Core bug fix/improvement
23 - [ ] New feature (It is strongly [recommended to open an issue first](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#adding-new-feature-or-making-overarching-changes))
24
25 ---
26
27 ### Description of your *pull request* and other information
28
29 Explanation of your *pull request* in arbitrary form goes here. Please **make sure the description explains the purpose and effect** of your *pull request* and is worded well enough to be understood. Provide as much **context and examples** as possible.