]> jfr.im git - yt-dlp.git/blame - .github/PULL_REQUEST_TEMPLATE.md
[version] update
[yt-dlp.git] / .github / PULL_REQUEST_TEMPLATE.md
CommitLineData
115add43 1**IMPORTANT**: PRs without the template will be CLOSED
2
31b532a1 3### Description of your *pull request* and other information
4
5</details>
6
7<!--
8
9Explanation 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
10
11-->
12
13ADD DESCRIPTION HERE
14
15Fixes #
16
17
ca9f1df2 18<details open><summary>Template</summary> <!-- OPEN is intentional -->
19
0a41f331 20<!--
ca9f1df2 21
22# PLEASE FOLLOW THE GUIDE BELOW
1f552340
S
23
24- You will be asked some questions, please read them **carefully** and answer honestly
0a41f331 25- Put an `x` into all the boxes `[ ]` relevant to your *pull request* (like [x])
1f552340
S
26- Use *Preview* tab to see how your *pull request* will actually look like
27
0a41f331 28-->
1f552340
S
29
30### Before submitting a *pull request* make sure you have:
b5ae35ee 31- [ ] 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)
7a5c1cfe 32- [ ] [Searched](https://github.com/yt-dlp/yt-dlp/search?q=is%3Apr&type=Issues) the bugtracker for similar pull requests
0a41f331 33- [ ] 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)
1f552340 34
2e7781a9 35### 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:
f1ee462c 36- [ ] I am the original author of this code and I am willing to release it under [Unlicense](http://unlicense.org/)
f3625cc4
S
37- [ ] 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)
38
1f552340 39### What is the purpose of your *pull request*?
0a41f331 40- [ ] Fix or improvement to an extractor (Make sure to add/update tests)
41- [ ] 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))
42- [ ] Core bug fix/improvement
43- [ ] 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))