# 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.


## Important!
> 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)
- [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 requests for additions to awesome-hyper before making a new one - your request may be a duplicate.
- Make an individual pull request for each suggestion to `awesome-hyper`.
- For Hyper **package** and **theme** names, please use the package name as published on npm, and as displayed in the URI of the package.
  - As an example, the title of `https://www.npmjs.com/package/hyper-snazzy` would be `hyper-snazzy`
- For new suggestions, use the following formatting `[hyper-plugin-name](link) - Your awesome description | [![npm](https://img.shields.io/npm/dm/hyper-plugin-name.svg?label=DL)](link)`
  - As an example, here's how `hyper-snazzy` would be formatted:
  - `[hyper-snazzy](https://www.npmjs.com/package/hyper-snazzy) - A super snazzy theme for Hyper, with muted off-neon colors. | [![npm](https://img.shields.io/npm/dm/hyper-snazzy.svg?label=DL)](https://www.npmjs.com/package/hyper-snazzy)`
- Link additions should be added to the **BOTTOM** or inserted according to the **ALPHABETICAL** order:
  - If it's a plugin or resource, put your awesome item at the **BOTTOM** of the correct section.
  - If it's a theme, insert it according to the **ALPHABETICAL** order.
- New categories or improvements to the existing categorization are _always_ 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.

Suggestions for ammendments to these guidelines are always welcome - feel free to submit an issue or pull request.

## How to: Add a plugin, theme, or resource to awesome-hyper

If you have something awesome to contribute to awesome-hyper list, this is how you can do it.

You'll need to have a GitHub account - you can [register here](https://github.com/join)!

1. Access awesome-hyper's GitHub page [here](https://github.com/bnb/awesome-hyper)
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, the maintainers of awesome-hyper 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-hyper list guidelines. We're always happy to help in any way we can.

[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.