# Contributing to Superface OneSDK

We welcome contributions to [OneSDK on GitHub](https://github.com/superfaceai/one-sdk-js).

**Please open an issue first if you want to make larger changes**

## Introduction

We are glad that you are interested in Superface in the way of contributing. We value the pro-community developers as you are.

## Help the community

1. Report an Error or a Bug
2. Contribute to the Documentation
3. Provide Support on Issues

## Need help?

If you have any question about this project (for example, how to use it) or if you just need some clarification about anything, please [open an issue](https://github.com/superfaceai/one-sdk-js/issues/new/choose) or check the [Support page](https://superface.ai/support) for other ways how to reach us.

## Contributing


### Contribute code

Follow these steps:

1. **Fork & Clone** the repository
2. **Setup** the OneSDK
   - Install packages with `yarn install` or `npm install`
   - Build with `yarn build` or `npm run build`
   - Run tests with `yarn test` or `npm test`
   - Lint code with `yarn lint:fix` or `npm run lint:fix`
3. **Update** [CHANGELOG](CHANGELOG.md). See [Keep a Changelog](https://keepachangelog.com/).
4. **Commit** changes to your own branch by convention. See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
5. **Push** your work back up to your fork.
6. Submit a **Pull Request** so that we can review your changes.

**NOTE:** Be sure to merge the latest commits from "upstream" before making a pull request.

**NOTE:** Please open an issue first if you want to make larger changes.

### Contribute by reporting bugs

If you are experiencing bug or undocumented behavior please [open an issue](https://github.com/superfaceai/one-sdk-js/issues/new/choose) with Bug report template.

### Contribute to documentation

Help us improve Superface documentation, you can fix typos, improve examples and more.

The documentation inside the OneSDK repository should be kept to minimum. The [Superface documentation](https://superface.ai/docs) is hosted in the [docs repository](https://github.com/superfaceai/docs).

## Allowed Licenses

Licenses of `node_modules` are checked during push CI/CD for every commit. Only the following licenses are allowed:

- 0BDS
- MIT
- Apache-2.0
- ISC
- BSD-3-Clause
- BSD-2-Clause
- CC-BY-4.0
- CC-BY-3.0;BSD
- CC0-1.0
- Unlicense

If a new dependency requires another license, just mention it in the respective issue or pull request, we will allow new licenses on the case-by-case basis.