mirror of
https://github.com/sindresorhus/awesome
synced 2024-11-23 20:43:09 +00:00
Merge pull request #284 from RichardLitt/feature/contribute
Attempt at separating out creating list vs contributing a list #266
This commit is contained in:
commit
e9a3d10e4d
3 changed files with 17 additions and 4 deletions
|
@ -1,12 +1,11 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
## Adding to this list
|
||||
|
||||
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.
|
||||
- Wait at least a couple of weeks after creating a list before submitting to give it a chance to mature.
|
||||
- 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.
|
||||
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
|
||||
- Make an individual pull request for each suggestion.
|
||||
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
|
||||
- Use the following format: `[List Name](link)`
|
||||
|
@ -18,6 +17,10 @@ Please ensure your pull request adheres to the following guidelines:
|
|||
|
||||
Thank you for your suggestions!
|
||||
|
||||
## Creating your own awesome list
|
||||
|
||||
To create your own list, check out the [instructions](create-list.md).
|
||||
|
||||
## Adding something to an Awesome list
|
||||
|
||||
If you have something awesome to contribute to an awesome list, this is how you do it.
|
||||
|
|
9
create-list.md
Normal file
9
create-list.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
# Creating Your Own List
|
||||
|
||||
- Read the [awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
|
||||
- Wait at least a couple of weeks after creating a list before submitting to this list to give it a chance to mature.
|
||||
- Search this list before making a new one, as yours may be a duplicate. If it is, try and contribute to the best one instead of making your own.
|
||||
- A link back to this list from yours, so users can discover more lists, would be appreciated.
|
||||
- Make sure you read the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) first.
|
||||
|
||||
Thanks for being awesome!
|
|
@ -12,6 +12,7 @@
|
|||
|
||||
If you want to contribute, please read the [contribution guidelines](contributing.md).
|
||||
|
||||
If you want to create your own list, please read the [create list instructions](create-list.md).
|
||||
|
||||
## Table of Contents
|
||||
|
||||
|
|
Loading…
Reference in a new issue