react-burgers-classname/CONTRIBUTING.md

fork of: [https://react-burgers.netlify.com/](https://react-burgers.netlify.com/) with added support for own className

# CONTRIBUTING

Contributions are always welcome, no matter how large or small!

## Setup

> Install yarn on your system: [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)

### Install dependencies

> Only required on the first run, subsequent runs can use `yarn dev` to both
bootstrap and run the development server.

```sh
$ git clone https://github.com/escaladesports/react-burgers
$ cd react-burgers
$ yarn
```

### Run locally

```sh
$ yarn dev
```

## Available scripts

### `dev`

Starts the development server.

#### Usage

```sh
$ yarn dev
```

### `build`

Builds the package for distribution.

#### Usage

```sh
yarn build
```

## Pull Requests

We actively welcome your pull requests even if you are a beginner!

1. Fork the repo.
2. Create a branch from `master`.
3. If you've changed APIs, update the documentation.
4. PR should be reviewed by two maintainers prior to merging.

## License

By contributing to react-burgers, you agree that your contributions will be licensed
under its [MIT license](LICENSE).