mirror of https://github.com/aldy505/code.git
21 lines
513 B
Markdown
21 lines
513 B
Markdown
|
# Contributing Guide
|
||
|
|
|
||
|
|
Thank you for considering to contribute on this code base.
|
||
|
|
|
||
|
|
## Development Setup
|
||
|
|
|
||
|
|
* Node.js v14.17.0 (LTS)
|
||
|
|
* Yarn v1.22.10 (or higher)
|
||
|
|
* Install required dependency
|
||
|
|
```bash
|
||
|
|
yarn install
|
||
|
|
```
|
||
|
|
* Start local development server
|
||
|
|
```bash
|
||
|
|
yarn dev
|
||
|
|
```
|
||
|
|
* Adhere to [commit convention](https://github.com/aldy505/code/blob/master/.github/COMMIT_CONVENTION.md) when you are writing a commit. Using [commitizen](https://commitizen.github.io/cz-cli/) is the recommended way.
|
||
|
|
```bash
|
||
|
|
git add .
|
||
|
|
git cz
|
||
|
|
```
|