Commit b7e11c

2016-11-18 19:50:14 Sindre Sorhus: Improve the pull request template
pull_request_template.md ..
@@ 1,21 1,31 @@
- <!-- Please fill in the **bold** fields and tick all applicable boxes by placing an "x" inside "[ ]". -->
+ <!-- Please fill in the **bold** fields -->
- **[URL to the list here.]**
+ **[Insert URL to the list here.]**
- **[Explain what this list is all about and why it should be included here.]**
+ **[Explain what this list is about and why it should be included here.]**
- # ALL THE BELOW CHECKBOXES SHOULD BE DONE AND CHECKED AND THE ABOVE PLACEHOLDERS SHOULD BE FILLED IN BEFORE SUBMITTING A PULL REQUEST!
- - [ ] I have read and understood the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) and the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
- - [ ] This pull request has a descriptive title. *(For example: `Add Node.js`)*
+ # By submitting this pull request I confirm I've read and complied with the below requirements.
+
+ Failure to properly do so will just result in the pull request being closed and everyone's time wasted. Please read it twice. Most people miss many things.
+
+ - I have read and understood the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) and the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
+ - This pull request has a descriptive title. For example, `Add Name of List`, not `Update readme.md` or `Add awesome list`.
+ - The entry in the Awesome list should include a short description about the list project/theme (not the list itself), and should be added at the bottom of the appropriate category.
- The list I added
- - [ ] **has been around for at least 20 days,**
- - [ ] is a non-generated Markdown file in a GitHub repo,
- - [ ] is not a duplicate,
- - [ ] only has awesome items with descriptions *(Awesome lists are curations of the best, not of everything)*,
- - [ ] contains the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge) on the right side of the list heading,
- - [ ] has a Table of Contents section named `Contents` as the first section,
- - [ ] has an [appropriate license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license) *(Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc)*,
- - [ ] has [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines),
- - [ ] has been checked for inconsistent formatting, spelling, and grammar *(This includes starting each link description with an uppercase character and ending it with a period `.`, and consistent naming)*,
- - [ ] has been added at the bottom of the appropriate category.
+ - **has been around for at least 30 days,**
+ - is the result of hard work and is the best I could possibly produce,
+ - is a non-generated Markdown file in a GitHub repo,
+ - is not a duplicate,
+ - includes a succinct description of the project/theme at the top ([example](https://github.com/willempienaar/awesome-quantified-self)),
+ - includes a project logo/illustration (whenever possible) at the top right of the readme ([example](https://github.com/sindresorhus/awesome-electron)). (The logo should link to the project website or any relevant website. The logo should be high-DPI, so set it to maximum half the width of the original image.),
+ - only has awesome items **with descriptions** *(Awesome lists are curations of the best, not of everything)*,
+ - contains the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge) on the right side of the list heading,
+ - has a Table of Contents section **named `Contents`** as the first section,
+ - has an [appropriate license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license) *(Meaning something like CC0, NOT a code licence like MIT, BSD, Apache, etc)* *(If you use a license badge, it should be SVG, not PNG)*,
+ - has [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines),
+ - doesn't include a Travis badge,
+ - has been checked for inconsistent formatting, spelling, and grammar:
+ - Each link description starts with an uppercase character and ends with a period.
+ - Drop all the `A` / `An` prefixes in the descriptions.
+ - Consistent naming. For example, `Node.js`, not `NodeJS` or `node.js`.
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9