Mirrors/awesome
2
0
Fork 0
mirror of https://github.com/sindresorhus/awesome synced 2024-11-25 13:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve the list guidelines

Browse source 
Fixes #1575
This commit is contained in:
Sindre Sorhus 2019-07-05 00:28:01 +07:00
parent 6c713a129a
commit efc69ed013
2 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
create-list.md
View file

@ -1,9 +1,9 @@
# Creating Your Own List # 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. - 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.** - **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! 😎

10
pull_request_template.md
View file

@ -41,6 +41,7 @@
- **Has been around for at least 30 days.**<br>That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent. - **Has been around for at least 30 days.**<br>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. - 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) - **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.` - ✅ `Mobile operating system for Apple phones and tablets.`
- ✅ `Prototyping interactive UI designs.` - ✅ `Prototyping interactive UI designs.`
@ -48,11 +49,16 @@
- ❌ `Awesome Framer packages and tools.` - ❌ `Awesome Framer packages and tools.`
- It's the result of hard work and the best I could possibly produce. - 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.** **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 Swift`
- ✅ `# Awesome Web Typography` - ✅ `# Awesome Web Typography`
- ❌ `# awesome-swift` - ❌ `# awesome-swift`
- ❌ `# ` - ❌ `# AwesomeSwift`
- Non-generated Markdown file in a GitHub repo. - 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. - 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. - Not a duplicate. Please search for existing submissions.