Skip to main content

Locally

Get the code on your system. Make sure you have completed the previous step i.e. pre-requisites.

  1. First of all Fork this project.

  2. Next -> clone your branch.

    git clone https://github.com/<your-user-name>/<nodelpers>.git

    note: replace <your-user-name> with your github username.

  3. 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>
  4. Use similar node version

    nvm use
  5. If you want to work on core package then install the packages in the root dir

    npm ci
  6. then run the tests

    npm run testall
  7. If you want to update the docs then move to docs dir and install the dependencies

    cd docs/
    npm ci
    npm run start

Now you have successfully clone the repo!

Start working on your first patch.

Follow CONTRIBUTING.md