Skip to content

Commit

Permalink
Update guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Oct 14, 2023
1 parent 07510cb commit 2f7d2c7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions awesome.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.`
Expand Down Expand Up @@ -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 `<h1>`.
- [ ] 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.
Expand Down

0 comments on commit 2f7d2c7

Please sign in to comment.