# Contribution Guidelines

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to react-valency. Feel free to propose changes to this document in a pull request.

## Pull Requests

Pull requests for new features, bug fixes, etc. are often appreciated.

**Working on your first Pull Request?** You can learn how from this _free_ series
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

Guidelines for pull requests:

- **Make your commit messages as descriptive as possible.** Include as much information as you can. Explain anything that the file diffs themselves won’t make apparent.
- **Document your pull request**. Explain your fix, link to the relevant issue, add screenshots when adding new icons.
- **Make sure the target of your pull request is the relevant branch**. Most of bugfix or new feature should go to the `master` branch.
- **Include only related work**. If your pull request has unrelated commit, it won't be accepted.

## Bug Reports

Before reporting an issue, please search to see if someone has filed a similar issue before. If there is already an open issue, please add a :+1: and/or leave a comment with additional information.

When creating a new issue make sure to include the following:

- Version of `react-valency` in use. Are you running from source/master? Are you using a released build? Which release?
- Your environment. What is your operating system? 32 or 64 bits?
- Step to reproduce. Even if the step is only one line change, **include it!** Include the actual result and what you expected.
- Any message or error you get in the console, if you do.
- A screenshot of any visual bug.

Here is what a great bug report would look like:

```
## Prerequisites

Version: Release v3.1.0
Running from: Import using webpack
Operating system: Mac OSX
Bits: 64 bits

## Step to reproduce

 - List steps
 - to reproduce
 - the bug here

### Actual behavior:

 - List the
 - actual expected
 - behaviour(s) here

## Any message or error

No console output
...

## Resources

No resources
...
```