DCellar Contribution Guide

Thanks for your interest in contributing to DCellar! Please take a moment to review this document before submitting a pull request.

Prerequisites

This project relies on nodejs, and use rushjs as a monorepo manager, make sure you have them installed:

First simply clone the repository, enter the directory and install packages:

git clone https://github.com/node-real/dcellar.git
cd dcellar
rush install

then, let's take dcellar-web-ui as example

First, you need to cd into the app's directory, and make it will be your working directory.

$ cd apps/dcellar-web-ui

Then, build the internal libs that it dependents

$ rush build -T .

You can run rushx command to run scripts in package.json.

$ rushx dev  # It will run 'dev' script in package.json

rushx is just like npm run

Now you can modify things and see the changes.

Just submit an issue though github issue page. Besides, before committing, git hook will automatically run eslint to check and fix errors.