Add CONTRIBUTING.md

2017-08-24 12:14:12 +02:00 · 2017-08-24 12:14:12 +02:00 · e8e8dd8136
parent d7391ccee2
commit e8e8dd8136
1 changed files with 39 additions and 0 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -0,0 +1,39 @@
+# 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.
+
+## Table of Contents
+
+- [Adding to this list](#adding-to-this-list)
+- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
+
+## 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 item is useful before submitting.
+- Make an individual pull request for each suggestion.
+- Use [title-casing](http://titlecapitalization.com) (AP style).
+- Use the following format: `[List Name](link) - Description.`
+- 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!
+
+## 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/)!