From 5c06f1cae933c670532e0b249ea2880ba08cbcf0 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Sun, 30 Apr 2017 17:31:53 +0700 Subject: [PATCH] Minor tweaks to guidelines --- pull_request_template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pull_request_template.md b/pull_request_template.md index 44c58534..700a967e 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -16,15 +16,15 @@ - 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. It should not describe the list itself.
Example: `- [Fish](…) - User-friendly shell.` + - Include a short description about the project/theme of the list. **It should not describe the list itself.**
Example: `- [Fish](…) - User-friendly shell.`, not `- [Fish](…) - Resources for Fish.`. - 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.**
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. + - **Includes a succinct description of the project/theme at the top of the readme.** [(Example)](https://github.com/willempienaar/awesome-quantified-self) + - The repo should have `awesome-list` & `awesome` as [GitHub topics](https://help.github.com/articles/about-topics). 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) @@ -43,6 +43,6 @@ - Has consistent formatting and proper spelling/grammar. - Each link description starts with an uppercase character and ends with a period.
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`. + - Consistent and correct naming. For example, `Node.js`, not `NodeJS` or `node.js`. - Doesn't include a Travis badge.
You can still use Travis for list linting, but the badge has no value in the readme. - Go to the top and read it again.