# Contributing

Contributions are welcome, and they are greatly appreciated! Every
little bit helps, and credit will always be given.

You can contribute in many ways:

## Types of Contributions

### Report Bugs

Report bugs at [https://github.com/sqreen/AgentNode/issues](https://github.com/sqreen/AgentNode/issues).

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

### Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug"
is open to whoever wants to implement it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with "feature"
is open to whoever wants to implement it.

### Write Documentation

Sqreen Node.js Agent could always use more documentation, whether as part of the
official Sqreen Node.js Agent docs or on the web in blog posts,
articles, and such.

### Submit Feedback

The best way to send feedback is to file an issue at  [https://github.com/sqreen/AgentNode/issues](https://github.com/sqreen/AgentNode/issues).

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
  are welcome :)

### Get Started!

#### Clone and install the project locally and install dependencies

```
$ git clone https://github.com/sqreen/AgentNode.git
$ cd AgentNode
$ npm install
$ npm run install-tests
```

> This should work with npm 2 and npm 3+

#### Run the tests

Run the tests with
```
$ npm test
```

* **Please run the tests before commit**

* **Please keep code coverage as high as possible**

#### Style

Please follow the style guide from the [hapi community](http://hapijs.com/styleguide) enforced by the test runner.

### Branching

The `master` branch is protected and always has the same codebase as the latest version published on npm.
The `dev` branch is protected. All PR should be created against it except for hotfixes and release.