From efc69ed013896c466df6e3ec89f0753eb92edc02 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Fri, 5 Jul 2019 00:28:01 +0700 Subject: [PATCH] Improve the list guidelines Fixes #1575 --- create-list.md | 8 ++++---- pull_request_template.md | 10 ++++++++-- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/create-list.md b/create-list.md index 3a8ef68..3ca8d3b 100644 --- a/create-list.md +++ b/create-list.md @@ -1,9 +1,9 @@ # Creating Your Own List -- Read the [awesome manifesto](awesome.md) and ensure your list complies. +- Read the [Awesome manifesto](awesome.md) and [list guidelines](pull_request_template.md) and ensure your list complies. - Search this list before making a new one, as yours may be a duplicate. If it is, try and contribute to the best one instead of making your own. -- Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](awesome.md#choose-an-appropriate-license), and [contribution guidelines](awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful. +- You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful. - **Wait at least 30 days after creating a list before submitting it, to give it a chance to mature.** -- **Make sure you read the [list guidelines](pull_request_template.md) before submitting a pull request for your list to be added here.** +- **Make sure you read the [list guidelines](pull_request_template.md) again before submitting a pull request for your list to be added here.** -Thanks for being awesome! +Thanks for being awesome! 😎 diff --git a/pull_request_template.md b/pull_request_template.md index e127b44..37429d1 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -41,6 +41,7 @@ - **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. - Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. +- Run [`awesome-lint`](https://github.com/sindresorhus/awesome-lint) on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please [report it](https://github.com/sindresorhus/awesome-lint/issues/new). - **Includes a succinct description of the project/theme at the top of the readme.** [(Example)](https://github.com/willempienaar/awesome-quantified-self) - ✅ `Mobile operating system for Apple phones and tablets.` - ✅ `Prototyping interactive UI designs.` @@ -48,11 +49,16 @@ - ❌ `Awesome Framer packages and tools.` - It's the result of hard work and the best I could possibly produce. **If you have not put in considerable effort into your list, your pull request will be immediately closed.** -- The heading title of your list should be in the following format: `# Awesome Name of List` +- The repo name of your list should be in lowercase slug format: `awesome-name-of-list`. + - ✅ `awesome-swift` + - ✅ `awesome-web-typography` + - ❌ `awesome-Swift` + - ❌ `AwesomeWebTypography` +- The heading title of your list should be in [title case](https://capitalizemytitle.com/) format: `# Awesome Name of List`. - ✅ `# Awesome Swift` - ✅ `# Awesome Web Typography` - ❌ `# awesome-swift` - - ❌ `# ` + - ❌ `# AwesomeSwift` - Non-generated Markdown file in a GitHub repo. - 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. Please search for existing submissions.