Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Removes content that was confusing, verbose, or only applied to the original `awesome` repo.
- Loading branch information
1 parent
56ca478
commit 986ae32
Showing
1 changed file
with
5 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,13 @@ | ||
| # Contribution Guidelines | ||
| # Adding to this list | ||
|
|
||
| Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms. | ||
| Please ensure your contribution adheres to the following guidelines: | ||
|
|
||
| # The pull request should have a useful title. | ||
|
|
||
| ## 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. | ||
| - Suggestions should be awesome! Only add resources that you can personally recommend. | ||
| - 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. | ||
| - Use [title-casing](http://titlecapitalization.com) (AP style). | ||
| - 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/sindresorhus/awesome | ||
| 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. | ||
| Thanks for your suggestions! |