# Contributing

You contributions are welcome! Please follow the guidelines below.

## Code Of Conduct

This project adheres to the Adobe [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to Grp-opensourceoffice@adobe.com.

## Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. Sign our [CLA](http://opensource.adobe.com/cla.html). You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!

# Steps

New to open source? Follow these steps for great success.

## 1. File an issue

An issue must exist before you start working on a fix or a feature.

First, [search the issues](https://github.com/adobe/vent/issues) to see if one has already been filed for what you're about to work on.

If not, [file an issue](https://github.com/adobe/vent/issues/new).

## 2. Fork the repo

[Fork Vent](https://github.com/adobe/vent/fork) to your Github account and clone it to your local machine.

Be sure to add an upstream remote:

```
git remote add upstream git@github.com:adobe/vent.git
```

## 3. Create a branch

Create a branch from master named `issue/#`, where # is the issue number you're going to work on:

```
git checkout master
git pull upstream master
git checkout -b issue/10
```

## 4. Write some consistent, maintainable, and tested code

Install dependencies and start developing:

```
npm install
npm run watch
```

The test suite will run automatically each time you save a file.

Be sure to match the existing coding style as well as comment anything that could benefit from an explaination.

Include tests for everything you change, and don't forget to test edge cases!

* If you fix a bug, include a test that proves you fixed it.
* If you added a feature, include a test that makes sure the feature works.

## 5. Make atomic commits that reference the issue

It's helpful if you make individual commits for atomic pieces of your contribution. This helps write a living history of the repository in the form of commit messages, and makes it much easier to understand why specific changes were made.

For instance, if you're working on a bug that affects two parts of the project, it may useful to have two commits for each part. Didn't make atomic commits? Don't sweat it, your contribution is still welcome!

Your commit message should contain the issue number it closes or fixes.

If the commit is only part of the solution:

```
Start with a blank prototype for the event map, related to #10
```

For commits that fix bugs:

```
Copy the array of listeners before executing them, fixes #10
```

For commits that implement features:

```
Support root-relative delegation, closes #10
```

## 6. Push and send a pull request

Push your branch to your fork:

```
git push -u origin issue/10
```

Then, [send a pull request](https://github.com/adobe/vent/compare) against the `master` branch of adobe/vent.