-
-
Notifications
You must be signed in to change notification settings - Fork 28.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
awesome manifesto #212
awesome manifesto #212
Conversation
@@ -0,0 +1,54 @@ | |||
# The awesome manifesto | |||
|
|||
If you want your list to be included on `awesome`, you should really |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you want your list to be included on
awesome
, you should really just include awesome stuff.
This makes me think this is a list of rules to be included in the list. It should just be a list of tips/guidelines about how to make your lists more awesome.
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also needs to explain what the contributing guidelines should guide about: formatting of the list, order, ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could copy a contributing.md from another awesome repository you like.
Isn't this enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay but then link up a good one (ours, for example)
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the link target correct? "no-license" looks like the wrong target.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@h4cc Yup, you're right, it should link to the homepage. I originally wanted to explain what happens when you don't select a license and I forgot to change it once I paraphrased the paragraph.
|
||
But **what is awesome?** | ||
|
||
## Only awesome is awesome. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The period at the end of this title is inconsistent.
so, does it look finished for the moment? Should we merge it? |
One small suggestion:
I bolded the words I think should be added. In my opinion, by leaving it like this, we're kind of encouraging people to just copy that file. In my opinion, that file should be a bit more descriptive and kind of depends on the topic of the list. |
I am kind of confused about the explanation "what is awesome". Should the list itself be awesome, or the linked content? A focus on the awesomeness of the list itself would be a better fit, i think. |
Both. It should link only to awesome resources and the list itself needs to be awesome (basically to follow everything from this pull request). |
@@ -0,0 +1,40 @@ | |||
# The awesome manifesto | |||
|
|||
If you want your list to be included on `awesome`, you should really just include awesome stuff. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
@strugee because it highlights the dangers of choosing no license. @sindresorhus incorporated your suggestions. |
Thanks @n1trux :) |
as stated in #207, we should discuss the guidelines about what is awesome here.