@eid-easy/eideasy-browser-js/docs/contributing/README.md

Official eID Easy javascript helper library for web browsers

# How to Contribute

## Repo
All work is done on [https://github.com/eideasy/eideasy-browser-js](https://github.com/eideasy/eideasy-browser-js).

## Semantic Versioning
eideasy-browser-js follows [semantic versioning](https://semver.org/)

## Branches
Make all pull requests directly against the [master branch](https://github.com/eideasy/eideasy-browser-js/tree/master).
Keep in mind that the master branch should always be in a releasable state as we might want to release a new minor version from the tip of the ``master`` at any time.

## Committing Changes
Commit messages should follow the [conventional commits](www.conventionalcommits.org) convention so that changelogs can be automatically generated.
We use [commitizen](https://github.com/commitizen/cz-cli) along with [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog) to
make following the convention easier.

## Development Setup

### Prerequisites
- [Node.js v12.x](https://nodejs.org/en/)
- [Yarn v1.x](https://classic.yarnpkg.com/lang/en/)

### Setup Guide
1. Clone the repo: [https://github.com/eideasy/eideasy-browser-js](https://github.com/eideasy/eideasy-browser-js)
2. Open the cloned project in a new terminal window
3. Run ``yarn`` to install the dependencies
4. Run ``yarn build`` to create a production build
For other available commands see: [package.json](https://github.com/eideasy/eideasy-browser-js/blob/master/package.json)

## Bugs
We are using [GitHub Issues](https://github.com/eideasy/eideasy-browser-js/issues) to keep track of our public bugs.

## How to Get in Touch
- [Slack](https://join.slack.com/t/eideasypartners/shared_invite/zt-mjn4e6mb-TmjcSzyZf4hEc1qsBHOHdQ)
- By email: info@eideasy.com