Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 1.14 KB
Raw

Contributing

Contributors are welcome!

See something that needs fixing? Got an idea for a new feature? Contribute a Pull Request!

Standard path to contribution

Prerequisites / Setup

  1. Fork the repo

    # The clone your copy
git clone <forked-repo>

  2. Install the dependencies

    # From the project directory, run
npm i

Be Create a Pull Request once you've written you code.

Develop

  • Write code
  • Validate code on node 16+ and V 0.3
  • Update README.md
  • Update examples folder
  • Create a PR
  • Have fun!

Create a Pull Request

  1. Fork it

  2. Clone it to your local system

  3. Make a new branch

  4. Make your changes

  5. Push it back to your repo

  6. From the Github UI, Click the Compare & pull request button

    NOTE: this button will be present for some period of time after 5. If the button no longer there, Create pull request and select the branches manually)

  7. From the Github UI, Click Create pull request to open a new pull request

  8. Detailed steps with example here:

Project structure

examples contains the code


## Thanks!