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

Close #212 PR: awesome manifesto. Fixes #207

Browse Source
This commit is contained in:
phre4k 2015-07-09 15:07:16 +02:00 committed by Sindre Sorhus
parent 244725a232
commit f8e6c2257c
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
awesome.md Normal file
View File

@ -0,0 +1,42 @@
# 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.
But **what is awesome?**
## Only awesome is awesome
Research if the stuff you're including is actually awesome. Put only stuff on the list you or another contributor can personally recommend and rather leave stuff out than include too much.
## 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.
## Make it clear on 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.
## Pay attention to grammar
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.
## 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.
A good license for your `awesome` lists could be [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
## 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.
## 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.
## 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.

3
readme.md
View File

@ -8,6 +8,9 @@
> A curated list of awesome lists
[What makes for an awesome list?](awesome.md)
If you want to contribute, please read the [contribution guidelines](contributing.md).
## TOC