# Contributing to react-DeepSpeech

Thanks for considering contribution to react-DeepSpeech. You can git clone the
react-DeepSpeech source on the following address and send PR with your patch. But,
before doing that, I recommend you to read this to follow the conventions.

https://github.com/Bogglian/react-DeepSpeech

```
$ git clone https://github.com/Bogglian/react-DeepSpeech.git
# OR
$ git clone https://github.com/Bogglian/react-DeepSpeech
```

## Coding style

The boggler is written in vscode. So we use the vscode extension for the coding style. follow:

- Prettier in vscode
- eslint in vscode

we use 'prettier-eslint' for default environment. also, use eslint plugin 'eslint-config-airbnb'.

https://github.com/prettier/prettier-eslint

```
$ yarn add eslint-config-airbnb
// or $ npm install eslint-config-airbnb
```

## Commit Style

Our commit messages conform to the following rules:

> Please don't write commit messages in the past. also, don't use periods in the title. But, please write in the content.

### Commit Style Types

|Title |Describe                                         |Usage - commit title                               |
|------|-------------------------------------------------|---------------------------------------------------|
|feat  |Add or Delete a feature.                         |feat: Add feature.js or feat: Add feature name     |
|fix   |fix the code                                     |fix: Modify code.js                                |
|docs  |All about documentation.                         |docs: Add title or docs: Modify README.md contents |
|env   |All about the development environment settings.  |env: Update Package.json or Update Packages        |

### Commit Contents

The contents of the commit should be as detailed as possible. For example:

```
feat: Add feature.js

We were having some kind of issue and decided to implement some feature to solve it.

As a result, I implemented this functionality through this commit. A description of this feature follows.

1. Do something.
2. Perform some function.
3. Some input is coming in and some output is coming out.

In addition, it is efficient to substitute any role of function.
```

## Issue Template

We are using [issue templates](.github/ISSUE_TEMPLATE/).