ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2025-01-05 15:45:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve pull request guidelines

Browse Source 
Based on feedback in #1390
This commit is contained in:
Sindre Sorhus 2018-10-16 23:25:12 +07:00
parent 056851611d
commit b2dee90758
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pull_request_template.md
View File

@ -34,17 +34,18 @@
- Not a duplicate. - Not a duplicate.
- Only has awesome items. Awesome lists are curations of the best, not everything. - Only has awesome items. Awesome lists are curations of the best, not everything.
- Includes a project logo/illustration whenever possible. - Includes a project logo/illustration whenever possible.
- Either fullwidth or placed at the top-right of the readme. [(Example)](https://github.com/sindresorhus/awesome-electron) - Either centered, fullwidth, or placed at the top-right of the readme. [(Example)](https://github.com/sindresorhus/awesome-electron)
- The image should link to the project website or any relevant website. - The image should link to the project website or any relevant website.
- The image should be high-DPI. Set it to maximum half the width of the original image. - The image should be high-DPI. Set it to maximum half the width of the original image.
- Entries have a description, unless the title is descriptive enough by itself. It rarely is though. - Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
- Includes the [Awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge). - Includes the [Awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge).
- Should be placed on the right side of the readme heading. - Should be placed on the right side of the readme heading.
- Can be placed centered if the list has a centered graphics header.
- Should link back to this list. - Should link back to this list.
- Has a Table of Contents section. - Has a Table of Contents section.
- Should be named `Contents`, not `Table of Contents`. - Should be named `Contents`, not `Table of Contents`.
- Should be the first section in the list. - Should be the first section in the list.
- Should only have one level of sub-lists, preferably none. - Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), preferably none.
- Has an [appropriate license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license). - Has an [appropriate license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license).
- That means something like CC0, **not a code licence like MIT, BSD, Apache, etc.** - That means something like CC0, **not a code licence like MIT, BSD, Apache, etc.**
- [WTFPL](http://www.wtfpl.net) and [Unlicense](http://unlicense.org) are not acceptable licenses. - [WTFPL](http://www.wtfpl.net) and [Unlicense](http://unlicense.org) are not acceptable licenses.