To develop on array-sync, all you need is Git, Node.js and NPM.
There are files for editors that should keep the file formatting consistent with what already exists in this repository.
Follow these steps to get started with hacking on array-sync.
- Star and fork this repository on GitHub.
- Clone your forked repository
git clone https://github.com/smebberson/array-sync.git ./array-sync. - Execute
yarn install.
With that, you'll have everything you need to get started.
The entire module lives within ./index.js. All tests can be found in test/test.js.
To run tests use yarn test. All tests are written using jest. Please write unit tests for new code you create.
Please send a GitHub pull request with a clear list of what you've done (read more about pull requests). Test coverage is at 100% and ideally, your pull requests will keep it as such.