From 5b498dd7005bd3ccfcad3316ecc17ffbe42af698 Mon Sep 17 00:00:00 2001 From: phre4k Date: Sat, 27 Jun 2015 14:36:37 +0200 Subject: [PATCH 1/9] added awesome manifesto --- awesome.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 awesome.md diff --git a/awesome.md b/awesome.md new file mode 100644 index 0000000000..db29bcf591 --- /dev/null +++ b/awesome.md @@ -0,0 +1,54 @@ +# The awesome manifesto + +If you want your list to be included on `awesome`, you should really +just include awesome stuff. + +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/no-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. + +### Include contribution guidelines + +People who are contributing to your list should have a clear +understanding how they should do so. You could copy a contributing.md +from another awesome repository you like. + +## 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. From bad665516a0abf7110e26181500fbc1023ec076b Mon Sep 17 00:00:00 2001 From: phre4k Date: Sat, 27 Jun 2015 14:51:18 +0200 Subject: [PATCH 2/9] removed hard line wrap caused by nano editor --- awesome.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/awesome.md b/awesome.md index db29bcf591..64d61e6772 100644 --- a/awesome.md +++ b/awesome.md @@ -1,54 +1,38 @@ # The awesome manifesto -If you want your list to be included on `awesome`, you should really -just include awesome stuff. +If you want your list to be included on `awesome`, you should really just include awesome stuff. 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. +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. +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. +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. +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/no-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. +See [Choose a License](http://choosealicense.com/no-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. ### Include contribution guidelines -People who are contributing to your list should have a clear -understanding how they should do so. You could copy a contributing.md -from another awesome repository you like. +People who are contributing to your list should have a clear understanding how they should do so. You could copy a contributing.md from another awesome repository you like. ## 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, 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. +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. From d82471f4c326d9296716c972be4545a6f4164cd3 Mon Sep 17 00:00:00 2001 From: phre4k Date: Sat, 27 Jun 2015 14:53:41 +0200 Subject: [PATCH 3/9] fixed wrong heading --- awesome.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index 64d61e6772..2093e989bd 100644 --- a/awesome.md +++ b/awesome.md @@ -25,7 +25,7 @@ Please be sure that you do your best to keep the list grammatically correct. Pay See [Choose a License](http://choosealicense.com/no-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. -### Include contribution guidelines +## Include contribution guidelines People who are contributing to your list should have a clear understanding how they should do so. You could copy a contributing.md from another awesome repository you like. From 78a3065ab7459c0c82f3946b47ae83e559288bb1 Mon Sep 17 00:00:00 2001 From: phre4k Date: Sat, 27 Jun 2015 22:16:49 +0200 Subject: [PATCH 4/9] clarification: choose a license links --- awesome.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index 2093e989bd..d656f3d156 100644 --- a/awesome.md +++ b/awesome.md @@ -23,7 +23,7 @@ Please be sure that you do your best to keep the list grammatically correct. Pay ## Choose an appropriate license -See [Choose a License](http://choosealicense.com/no-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. +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. ## Include contribution guidelines From cc328b67c56221fa75346291f66359f2657d6c38 Mon Sep 17 00:00:00 2001 From: phre4k Date: Sat, 27 Jun 2015 23:18:54 +0200 Subject: [PATCH 5/9] included rel. link to contributing --- awesome.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index d656f3d156..80a35726a9 100644 --- a/awesome.md +++ b/awesome.md @@ -27,7 +27,7 @@ See [Choose a License](http://choosealicense.com/) for more details. Keep in min ## Include contribution guidelines -People who are contributing to your list should have a clear understanding how they should do so. You could copy a contributing.md from another awesome repository you like. +People who are contributing to your list should have a clear understanding how they should do so. You could copy a [contributing.md](contributing.md) from another awesome repository you like. ## Stylize your list properly From c486df970181986cd8f33dcd9319e2616b41d5ab Mon Sep 17 00:00:00 2001 From: phre4k Date: Tue, 30 Jun 2015 08:33:59 +0200 Subject: [PATCH 6/9] fix inconsistency, add link to readme --- awesome.md | 2 +- readme.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index 80a35726a9..d7feb71d4f 100644 --- a/awesome.md +++ b/awesome.md @@ -4,7 +4,7 @@ If you want your list to be included on `awesome`, you should really just includ But **what is awesome?** -## Only awesome 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. diff --git a/readme.md b/readme.md index f4dadbb845..b066147adf 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,8 @@ > A curated list of awesome lists +We did a small document about [what awesome is](awesome.md).\\ If you want to contribute, please read the [contribution guidelines](contributing.md). + ## TOC From 4212ce14e46ead70a40bccaafe9fa40457af6845 Mon Sep 17 00:00:00 2001 From: phre4k Date: Tue, 30 Jun 2015 08:36:08 +0200 Subject: [PATCH 7/9] damn different markdown implementations --- readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index b066147adf..57cc32982e 100644 --- a/readme.md +++ b/readme.md @@ -2,7 +2,8 @@ > A curated list of awesome lists -We did a small document about [what awesome is](awesome.md).\\ If you want to contribute, please read the [contribution guidelines](contributing.md). +We did a small document about [what awesome is](awesome.md). +If you want to contribute, please read the [contribution guidelines](contributing.md). ## TOC From b2fac2334c560d5e5ec5c7c060bb1a0442e43a5c Mon Sep 17 00:00:00 2001 From: phre4k Date: Thu, 2 Jul 2015 12:31:12 +0200 Subject: [PATCH 8/9] + contribution wording by @aleksandar-todorovic --- awesome.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/awesome.md b/awesome.md index d7feb71d4f..bd885f3e5a 100644 --- a/awesome.md +++ b/awesome.md @@ -27,7 +27,9 @@ See [Choose a License](http://choosealicense.com/) for more details. Keep in min ## Include contribution guidelines -People who are contributing to your list should have a clear understanding how they should do so. You could copy a [contributing.md](contributing.md) from another awesome repository you like. +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 copy a [contributing.md](contributing.md) from another awesome repository you like. ## Stylize your list properly From ea6c0456873b41ffe7dd694cec71d137f5a42e9d Mon Sep 17 00:00:00 2001 From: phre4k Date: Thu, 9 Jul 2015 15:03:14 +0200 Subject: [PATCH 9/9] include @sindresorhus suggestions --- awesome.md | 6 ++++-- readme.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/awesome.md b/awesome.md index bd885f3e5a..2053ffe155 100644 --- a/awesome.md +++ b/awesome.md @@ -1,6 +1,6 @@ # The awesome manifesto -If you want your list to be included on `awesome`, you should really just include awesome stuff. +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?** @@ -25,11 +25,13 @@ Please be sure that you do your best to keep the list grammatically correct. Pay 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 copy a [contributing.md](contributing.md) from another awesome repository you like. +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 diff --git a/readme.md b/readme.md index 57cc32982e..c66fea6c18 100644 --- a/readme.md +++ b/readme.md @@ -2,7 +2,7 @@ > A curated list of awesome lists -We did a small document about [what awesome is](awesome.md). +[What makes for an awesome list?](awesome.md) If you want to contribute, please read the [contribution guidelines](contributing.md).