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