Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (32 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 1.17 KB

Contribution Guide

Guidelines

We would love your contributions to make this project better, and gladly accept PRs.

Note: please try to keep changes incremental. Big refactors cause heartburn, please try to make frequent, small PRs instead of large ones.

Setting up the project

Use nvm to use the appropriate Node.js version from .nvmrc:

nvm i

Install the dependencies using npm:

npm i

Building the project

Run the build script:

npm run build

The package is bundled using pkgroll (Rollup). It infers the entry-points from package.json so there are no build configurations.

Development

To run the CLI locally without installing it globally, you can use the start script:

npm start

Check the lint in order to pass

First, install prettier.

npm run lint:fix

If you use Vscode, It is recommended to use prettier-vscode

Send a pull request

Once you have made your changes, push them to your fork and send a pull request to the main repository. We will try to review your changes in a timely manner.