Initial commit
This commit is contained in:
maximabramchuck
commit
8ea99db97d
|
|
@ -0,0 +1,55 @@
|
|||
# The awesome manifesto
|
||||
|
||||
If you want your list to be included on `awesome`, try to only include actual 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.
|
||||
|
||||
## Awesome badge
|
||||
|
||||
[](https://github.com/sindresorhus/awesome)
|
||||
|
||||
Add an awesome badge to the top of your list, right to the title. [Example](https://github.com/sindresorhus/awesome-nodejs).
|
||||
|
||||
```md
|
||||
[](https://github.com/sindresorhus/awesome)
|
||||
```
|
||||
|
||||
## Comment on why something is awesome
|
||||
|
||||
Apart from suggesting a particular item on your list, you should also inform your readers *why* it's on the list and how they will benefit from it.
|
||||
|
||||
## Make it clear what the list is about
|
||||
|
||||
Have a succinct description at the top of your readme. 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
|
||||
|
||||
Ensure your list is grammatically correct, typo free and has no Markdown formatting errors. This should also apply to pull requests.
|
||||
|
||||
## Choose an appropriate license
|
||||
|
||||
Keep in mind that if you [haven't selected a license](http://choosealicense.com/no-license/), it basically means the people are *not* allowed to reproduce, distribute or create derivative works.
|
||||
|
||||
[Creative Commons licenses](https://creativecommons.org/) are perfect for this purpose. **We would recommend [`CC0`](https://creativecommons.org/publicdomain/zero/1.0/).** Code licenses like MIT, BSD, GPL, and so forth are not recommended.
|
||||
|
||||
## 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, feel free to take our [contributing.md](contributing.md) and modify it to your own needs.
|
||||
|
||||
## Stylize your list properly
|
||||
|
||||
Create a table of contents, organize the content into different categories, and use images if suitable. Ensure all entries are consistent (e.g. all entry descriptions end in a `.`).
|
||||
|
||||
## 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.
|
||||
|
||||
## Discovery
|
||||
|
||||
Link back to this list from your list so users can easily discover more lists.
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
# Contribution Guidelines
|
||||
|
||||
## Table of Contents
|
||||
- [Adding to this list](#adding-to-this-list)
|
||||
- [Creating your own awesome list](#creating-your-own-awesome-list)
|
||||
- [Adding something to an Awesome list](#adding-something-to-an-awesome-list)
|
||||
- [Updating your Pull Request](#updating-your-pull-request)
|
||||
|
||||
## Adding to this list
|
||||
|
||||
Please ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
- 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.
|
||||
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
||||
- Use the following format: `[List Name](link)`
|
||||
- Link additions should be added to the bottom of the relevant category.
|
||||
- New categories or improvements to the existing categorization are welcome.
|
||||
- Check your spelling and grammar.
|
||||
- Make sure your text editor is set to remove trailing whitespace.
|
||||
- The pull request and commit should have a useful title.
|
||||
- The body of your commit message should contain a link to the repository.
|
||||
|
||||
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.
|
||||
|
||||
You'll need a [GitHub account](https://github.com/join)!
|
||||
|
||||
1. Access the awesome list's GitHub page. For example: https://github.com/MaximAbramchuck/awesome-interviews
|
||||
2. Click on the `README.md` file: 
|
||||
3. Now click on the edit icon. 
|
||||
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). 
|
||||
5. Say why you're proposing the changes, and then click on "Propose file change". 
|
||||
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
|
||||
|
||||
## Updating your Pull Request
|
||||
|
||||
Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
|
||||
|
||||
[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
# Creating Your Own List
|
||||
|
||||
- Read the awesome manifesto 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 contributing guide before submitting a request for your list to be added here.
|
||||
|
||||
Thanks for being awesome!
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
# Awesome *your list name* [](https://github.com/sindresorhus/awesome)
|
||||
|
||||
> A curated list of <your list name>.
|
||||
|
||||
[What makes for an awesome list?](awesome.md)
|
||||
|
||||
Please read the [contribution guidelines](contributing.md) or the [creating a list guide](create-list.md) if you want to contribute.
|
||||
|
||||
### Table of Contents
|
||||
|
||||
- [Awesome List item](#list-item)
|
||||
- [Awesome List sub item](#list-sub-item)
|
||||
- [Awesome List sub item](#list-sub-item-1)
|
||||
- [Awesome List sub item](#list-sub-item-2)
|
||||
|
||||
## Awesome List item
|
||||
|
||||
### Awesome List sub item
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
|
||||
### Awesome List sub item
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
|
||||
### Awesome List sub item
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
- [link](https://github.com/MaximAbramchuck/awesome-interviews) - Awesome link
|
||||
|
||||
### License
|
||||
|
||||
[](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
Loading…
Reference in New Issue