awesome/contributing.md

# Contribution Guidelines

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.

# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.

## 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://titlecase.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/sindresorhus/awesome
2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
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/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
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/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
add contribution guidelines 2015-05-21 10:23:54 +00:00			`# Contribution Guidelines`

add Code of Conduct 2016-01-14 22:55:30 +00:00			`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.`

🐐 2016-05-03 09:58:47 +00:00			# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.

Added TOC, fixed capital 2015-11-01 15:21:35 +00:00			`## Table of Contents`
add Code of Conduct 2016-01-14 22:55:30 +00:00
Added TOC, fixed capital 2015-11-01 15:21:35 +00:00			`- [Adding to this list](#adding-to-this-list)`
			`- [Creating your own awesome list](#creating-your-own-awesome-list)`
Minor edit I changed the case of “Awesome” in this link to match other links’ formatting and the case of the section it links to for consistency. 2016-02-27 05:18:39 +00:00			`- [Adding something to an awesome list](#adding-something-to-an-awesome-list)`
Added TOC, fixed capital 2015-11-01 15:21:35 +00:00			`- [Updating your Pull Request](#updating-your-pull-request)`

Attempt at separating out creating list vs contributing a list #266 2015-08-21 19:50:01 +00:00			`## Adding to this list`

add contribution guidelines 2015-05-21 10:23:54 +00:00			`Please ensure your pull request adheres to the following guidelines:`

			`- Search previous suggestions before making a new one, as yours may be a duplicate.`
Attempt at separating out creating list vs contributing a list #266 2015-08-21 19:50:01 +00:00			`- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.`
add contribution guidelines 2015-05-21 10:23:54 +00:00			`- Make an individual pull request for each suggestion.`
Update title casing website in contributing.md (#1303) 2018-05-23 03:15:32 +00:00			`- Use [title-casing](http://titlecase.com) (AP style).`
add contribution guidelines 2015-05-21 10:23:54 +00:00			- Use the following format: `[List Name](link)`
contributing guideliens - add mention of where new items should be added #201 2015-06-24 07:53:37 +00:00			`- Link additions should be added to the bottom of the relevant category.`
add contribution guidelines 2015-05-21 10:23:54 +00:00			`- 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.`
Adds one line to the "Adding to this list" section By browsing through the PRs that we're getting on a daily basis, it seems like it would be easier to request from the people to submit a link directly in the body of the commit message. That way, we can just click on it instead of switching to the `Files` tab, copying it and then pasting it in a new browser tab. It's just something that came to my mind like right now, so I'm gonna wait for the feedback first. 2015-11-03 14:30:23 +00:00			`- The body of your commit message should contain a link to the repository.`
add contribution guidelines 2015-05-21 10:23:54 +00:00
			`Thank you for your suggestions!`
Close #281 PR: Close #269. How to submit to an awesome list. 2015-08-21 06:54:29 +00:00
Attempt at separating out creating list vs contributing a list #266 2015-08-21 19:50:01 +00:00			`## Creating your own awesome list`

			`To create your own list, check out the [instructions](create-list.md).`

Added TOC, fixed capital 2015-11-01 15:21:35 +00:00			`## Adding something to an awesome list`
Close #281 PR: Close #269. How to submit to an awesome list. 2015-08-21 06:54:29 +00:00
			`If you have something awesome to contribute to an awesome list, this is how you do it.`

cleanup #281 2015-08-21 07:00:28 +00:00			`You'll need a [GitHub account](https://github.com/join)!`
Close #281 PR: Close #269. How to submit to an awesome list. 2015-08-21 06:54:29 +00:00
cleanup #281 2015-08-21 07:00:28 +00:00			`1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome`
			2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
			`3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)`
			`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/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)`
			`5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)`
			`6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!`
Added Updating your Pull Request section 2015-11-01 15:21:41 +00:00
			`## 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.`

Fix link in contributing.md Fixes #1118 2017-11-03 15:43:15 +00:00			`[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.`