# How to contribute

## Configuring

Firstly you need login your npm account, for this, just type:

```bash
npm adduser
```

After this command, type:

```bash
npm login
```

In these commands you will fill in your access information. After login, you
should clone this repository and access the project folder, already in the
project folder, type:

```bash
npm config set scope @crawly
```

Now your project is configured.

**Note**: You need to have a permission in "crawly" organization.

## Publishing

Once you have made your changes, for you to publish, you need to commit the
changes first, after which you need to change the version of the project using
the command:

```bash
npm version <newversion>
```

To learn which version to use, you can read: https://docs.npmjs.com/about-semantic-versioning

After updating the version, a tag with the new version is generated in git, you
can now push that tag and publish the package:

```bash
git push origin YOUBRANCH --tags && npm publish
```