ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2024-12-18 15:06:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update guidelines

Browse Source
This commit is contained in:
Sindre Sorhus 2023-10-14 23:00:09 +07:00
parent 07510cb399
commit 2f7d2c71e6
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
awesome.md
View File

@ -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) [![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.* *The badges should not be modified in any way.*
## Awesome mentioned badge ## Awesome mentioned badge

3
pull_request_template.md
View File

@ -26,7 +26,7 @@
- ❌ `add Swift` - ❌ `add Swift`
- ❌ `Adding Swift` - ❌ `Adding Swift`
- ❌ `Added 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.` - ✅ `- [iOS](…) - Mobile operating system for Apple phones and tablets.`
- ✅ `- [Framer](…) - Prototyping interactive UI designs.` - ✅ `- [Framer](…) - Prototyping interactive UI designs.`
- ❌ `- [iOS](…) - Resources and tools for iOS development.` - ❌ `- [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) - 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 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. - **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. - [ ] 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). - [ ] 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. - Should be placed on the right side of the readme heading.