mirror of
https://github.com/sindresorhus/awesome.git
synced 2024-12-18 15:06:08 +00:00
improve the awesome manifesto
This commit is contained in:
parent
f8e6c2257c
commit
8e8a924010
25
awesome.md
25
awesome.md
@ -1,6 +1,6 @@
|
||||
# The awesome manifesto
|
||||
|
||||
If you want your list to be included on `awesome`, try to only include awesome stuff in your list. After all, it's a curation, not a collection.
|
||||
If you want your list to be included on `awesome`, try to only include actual awesome stuff in your list. After all, it's a curation, not a collection.
|
||||
|
||||
But **what is awesome?**
|
||||
|
||||
@ -10,33 +10,36 @@ Research if the stuff you're including is actually awesome. Put only stuff on th
|
||||
|
||||
## Comment on why something is awesome
|
||||
|
||||
Apart from suggesting a particular item on your list, you also should tell your readers _why_ you do suggest it and how the potential users will benefit from using it.
|
||||
Apart from suggesting a particular item on your list, you should also inform your readers *why* it's on the list and how they will benefit from it.
|
||||
|
||||
## Make it clear on what the list is about
|
||||
## Make it clear what the list is about
|
||||
|
||||
Make sure your list covers a certain scope and nothing else.
|
||||
Link to other awesome lists if you think they already cover a certain subject good enough.
|
||||
Have a succinct description at the top of your readme. Make sure your list covers a certain scope and nothing else. Link to other awesome lists if you think they already cover a certain subject good enough.
|
||||
|
||||
## Pay attention to grammar
|
||||
## Pay attention to gramar
|
||||
|
||||
Please be sure that you do your best to keep the list grammatically correct. Pay attention to Markdown formatting errors as well, only accept pull requests with proper formatting.
|
||||
Ensure your list is grammatically correct, typo free and has no Markdown formatting errors. This should also apply to pull requests.
|
||||
|
||||
## Choose an appropriate license
|
||||
|
||||
See [Choose a License](http://choosealicense.com/) for more details. Keep in mind that if you [haven't](http://choosealicense.com/no-license/) selected a license, it basically means the people are *not* allowed to reproduce, distribute or create derivative works.
|
||||
Keep in mind that if you [haven't selected a license](http://choosealicense.com/no-license/), it basically means the people are *not* allowed to reproduce, distribute or create derivative works.
|
||||
|
||||
A good license for your `awesome` lists could be [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
|
||||
[Creative Commons licenses](https://creativecommons.org/) are perfect for this purpose. **We would recommend [`CC0`](https://creativecommons.org/publicdomain/zero/1.0/).** Code licenses like MIT, BSD, GPL, etc, are not recommended.
|
||||
|
||||
## Include contribution guidelines
|
||||
|
||||
People who are contributing to your list should have a clear understanding how they should do so.
|
||||
|
||||
If you don't feel like writing one from scratch, you could read a [contributing.md](contributing.md) from another awesome repository you like and base yours on it.
|
||||
If you don't feel like writing one from scratch, feel free to take our [contributing.md](contributing.md) and modify it to our own needs.
|
||||
|
||||
## Stylize your list properly
|
||||
|
||||
Create a table of contents, put a picture in it where you think it fits, organize the content into different categories.
|
||||
Create a table of contents, organize the content into different categories, use images if suitable. Ensure all entries are consistent, eg. all entry descriptions ending in a `.`.
|
||||
|
||||
## Accept other people's opinion
|
||||
|
||||
If you're an owner of the list, respect other people's opinion. If there are plenty of users not agreeing to your decision, give it a second thought.
|
||||
|
||||
## Discovery
|
||||
|
||||
Link back to this list from your list so users can easily discover more lists.
|
||||
|
@ -2,6 +2,7 @@
|
||||
|
||||
Please ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
|
||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
|
||||
- A link back to this list from yours, so users can discover more lists, would be appreciated.
|
||||
|
Loading…
Reference in New Issue
Block a user