You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.0 KiB

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 for more details. Keep in mind that if you haven't 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.

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 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.