This contributor guide is mainly for Zapier employees. However, zapier-platform is a public repo. Everyone is welcome to submit a pull request (PR). For non-employees, you must agree to the terms of service listed on https://zapier.com/platform/tos or the LICENSE file of the repo before contributing.
Install Yarn if you haven't. We use Yarn to manage packages.
Clone this repo with git:
git clone [email protected]:zapier/zapier-platform.git
cd zapier-platformIn the repo directory, install dependencies with yarn:
yarnThat's it! Now you have a local environment for development.
You can run all tests for all packages with yarn test:
yarn testYou seldom need to run all the tests because we have CI do it. You have several ways to filter running tests.
To run tests for a single package, you go into the package directory and run yarn test. For example, this is how you run all the tests for the cli package:
cd packages/cli
yarn testTBA
Zapier employees only. Refer to this internal doc on how to cut a release.