From 2f7d2c71e6d7e0db8b99288779f78945d8b6c2b4 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Sat, 14 Oct 2023 23:00:09 +0700 Subject: [PATCH] Update guidelines --- awesome.md | 2 ++ pull_request_template.md | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index c683a8e4..1bae22f9 100644 --- a/awesome.md +++ b/awesome.md @@ -24,6 +24,8 @@ Add an awesome badge to the top of your list, right next to the title. [Example] [![Awesome](https://awesome.re/badge-flat2.svg)](https://awesome.re) ``` +You are allowed to use the badge on lists not included here and also private lists. + *The badges should not be modified in any way.* ## Awesome mentioned badge diff --git a/pull_request_template.md b/pull_request_template.md index 6c2508fc..72dd17db 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -26,7 +26,7 @@ - ❌ `add Swift` - ❌ `Adding Swift` - ❌ `Added Swift` -- [ ] Your entry here should include a short description about the project/theme of the list. **It should not describe the list itself.** The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb. +- [ ] Your entry here should include a short description about the project/theme of the list. **It should not describe the list itself.** The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb. It should not contain the name of the list. - ✅ `- [iOS](…) - Mobile operating system for Apple phones and tablets.` - ✅ `- [Framer](…) - Prototyping interactive UI designs.` - ❌ `- [iOS](…) - Resources and tools for iOS development.` @@ -69,6 +69,7 @@ - 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 be high-DPI.** Set it to maximum half the width of the original image. + - Don't include both a title saying `Awesome X` and a logo with `Awesome X`. You can put the header image in a `#` (Markdown header) or `

`. - [ ] 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/main/awesome.md#awesome-badge). - Should be placed on the right side of the readme heading.