Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Committing

Please follow the commit message format for your pull requests and for your commits.

$ git clone https://github.com/forivall/tacoscript
$ cd tacoscript
$ npm run bootstrap

Then, after making changes, you can either run:

$ npm run build

to build Tacoscript once or:

$ npm run watch

to have Tacoscript build itself then incrementally build files on change.

If you want sourcemaps with your build, or if you find that the watch script is slow, you can use gulp instead.

$ npm run install-potato # (once)
$ npm run watch-dev
# or
$ gulp watch

Note: Make sure you have already built the code (or are using watch) prior to running tests.

You can run tests for all packages via:

$ npm run test

This is mostly overkill and you can limit the package to a select by using the TEST_ONLY environment variable:

$ TEST_ONLY=horchata make test

You can also run tests directly from within a package directory:

$ cd packages/horchata
$ npm run test

mocha can also be run directly, to pass other arguments, but only when inside a package directory.

$ cd packages/horchata
$ mocha --grep "location"

To test the code coverage, use:

$ npm run test-cov