# Contributing

I love every form of contribution. By participating to this project, you agree
to abide to the deluminator [code of conduct](/CODE_OF_CONDUCT.md).

## Setup your machine

`deluminator` is written in [Go](https://golang.org/).

Prerequisites are:

* Build:
  * `make`
  * [Go 1.8+](http://golang.org/doc/install) (of course! :))
* Test:
  * [PostgreSQL](https://www.postgresql.org/)
  * [MySQL](https://www.mysql.com/)
  * [PhantomJS](http://phantomjs.org/)

Clone `deluminator` from source:

```sh
$ git clone https://github.com/lucapette/deluminator.git
$ cd deluminator
```

Install the build and lint dependencies:

``` sh
$ make setup
```

A good way of making sure everything is all right is running the test suite:

``` sh
$ make test
```

## Test your change

You can create a branch for your changes and try to build from the source as you go:

``` sh
$ make build
```

When you are satisfied with the changes, I suggest you run:

``` sh
$ make ci
```

Which runs all the linters and tests.

## Submit a pull request

Push your branch to your `deluminator` fork and open a pull request against
the master branch.

# Contributing

I love every form of contribution. By participating to this project, you agree
to abide to the `deluminator` [code of conduct](/CODE_OF_CONDUCT.md).

## Setup your machine

`deluminator` is written in [Go](https://golang.org/).

Prerequisites are:

* Build:
  * `make`
  * [Go 1.8+](http://golang.org/doc/install) (of course! :))
* Test:
  * [PostgreSQL](https://www.postgresql.org/)
  * [MySQL](https://www.mysql.com/)
  * [PhantomJS](http://phantomjs.org/)

Clone `deluminator` from source:

```sh
$ git clone https://github.com/lucapette/deluminator.git
$ cd deluminator
```

Install the build and lint dependencies:

``` sh
$ make setup
```

A good way of making sure everything is all right is running the test suite:

``` sh
$ make test
```

## Test your change

You can create a branch for your changes and try to build from the source as you go:

``` sh
$ make build
```

When you are satisfied with the changes, I suggest you run:

``` sh
$ make ci
```

Which runs all the linters and tests.

## Submit a pull request

Push your branch to your `deluminator` fork and open a pull request against
the master branch.

Use always the same format in docs
Use always the same format in docs
