2017-04-01 13:09:47Sindre Sorhus:
Improve the pull request template
Fixes #908
pull_request_template.md ..
@@ 1,31 1,48 @@
-
<!-- Please fill in the **bold** fields -->
-
**[Insert URL to the list here.]**
+
<!-- Congrats on creating an Awesome list! 🎉 -->
-
**[Explain what this list is about and why it should be included here.]**
+
+
<!-- Please fill in the below placeholders -->
+
+
**[Insert URL to the list here]**
+
+
**[Explain what this list is about and why it should be included here]**
# 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.
+
**Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.**
- 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 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.
+
- This pull request has a descriptive title.<br>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. It should not describe the list itself.<br>Example: `- [Fish](…) - User-friendly shell.`
+
- Be added at the bottom of the appropriate category.
+
- The list I'm submitting complies with these requirements:
+
- **Has been around for at least 30 days.**<br>That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
+
- It's the result of hard work and the best I could possibly produce.
+
- Non-generated Markdown file in a GitHub repo.
+
- The repo should have the following [GitHub topics](https://help.github.com/articles/about-topics) set: `awesome-list`, `awesome`, `list`. I encourage you to add more relevant topics.
+
- Not a duplicate.
+
- Includes a succinct description of the project/theme at the top of the readme. [(Example)](https://github.com/willempienaar/awesome-quantified-self)
+
- Only has awesome items. Awesome lists are curations of the best, not everything.
+
- Includes a project logo/illustration whenever possible.
+
- 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 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.
+
- Has 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.
+
- Should be named `Contents`, not `Table of Contents`.
+
- Should be the first section in the list.
+
- 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.**
+
- 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).
+
- The file should be named `contributing.md`. Casing is up to you.
+
- Has consistent formatting and proper spelling/grammar.
+
- Each link description starts with an uppercase character and ends with a period.<br>Example: `- [AVA](…) - JavaScript test runner.`
- Drop all the `A` / `An` prefixes in the descriptions.
- Consistent naming. For example, `Node.js`, not `NodeJS` or `node.js`.
+
- Doesn't include a Travis badge.<br>You can still use Travis for list linting, but the badge has no value in the readme.
