Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 711 Bytes

CONTRIBUTING.md

File metadata and controls

50 lines (32 loc) · 711 Bytes

Contributing

Contributors are welcome!

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

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

Run the tests

  1. Run the tests

    npm test

Develop

  • Write code
  • Add tests to validate new behaviors
  • Ensure all tests succeed
  • Create a PR
  • Have fun!

Project structure

src contains the source code test contains the tests

Need help?

Reach out on gitter.

We're happy to help!

Thanks!