Locally
Get the code on your system. Make sure you have completed the previous step i.e. pre-requisites
.
-
First of all Fork this project.
-
Next
->
clone your branch.git clone https://github.com/<your-user-name>/<nodelpers>.git
note
: replace<your-user-name>
with your github username. -
Move to cloned dir and if you want to make changes to our codebase then create new branch
cd nodelpers/
git checkout -b <your-branch-name> -
Use similar node version
nvm use
-
If you want to work on
core
package then install the packages in the root dirnpm ci
-
then run the tests
npm run testall
-
If you want to update the
docs
then move to docs dir and install the dependenciescd docs/
npm ci
npm run start
Now you have successfully clone the repo!
Start working on your first patch.
Follow CONTRIBUTING.md