Contributing

PR's are welcome and encouraged in this repository. Read this document to see how to contribute.

Project Structure

This project is built with Nx and follows the standard project structure. Visit the Getting Started guide to familiarize yourself with Nx workspaces.

This workspace uses the Nx CLI with npm 6.x

After cloning the project, to install the dependencies, run:

npm i

To build a plugin, run:

npm run build {plugin}

To run unit tests for a plugin, run:

npm run test {plugin}

To run e2e tests for a plugin, run:

npm run e2e {plugin}

To test a plugin locally, build the plugin:

npm run build {plugin}

Next, navigate to the build output directory:

cd dist/packages/{plugin}

Next, if you want to test the plugin on a project that uses Yarn, run:

yarn link

If you want to test the plugin on a project that uses NPM, run:

npm link

Finally, in the project that you want to test, run:

yarn link @efacity/{plugin}

Or:

npm link @efacity/{plugin}

Ensure that you have completed the PR checklist in the pull request template prior to opening a pull request.