When it comes to open source, there are different ways you can contribute, all of which are valuable. Here's few guidelines that should help you as you prepare your contribution.
Before you start working on a contribution, create an issue describing what you want to build. It's possible someone else is already working on something similar, or perhaps there is a reason that feature isn't implemented. The maintainers will point you in the right direction.
The following steps will get you setup to contribute changes to this repo:
-
Fork this repo.
-
Clone your forked repo:
git clone [email protected]:{your_username}/zod.git -
Run
yarnto install dependencies. -
Start playing with the code! You can do some simple experimentation in
playground.ts(seeyarn playbelow) or start implementing a feature right away.
yarn build
- deletes
liband re-compilessrctolib
yarn test
- runs all Jest tests and generates coverage badge
yarn test enum
- runs a single test file (e.g.
enum.test.ts)
yarn play
- executes
playground.ts, watches for changes. useful for experimentation
Zod uses Jest for testing. After implementing your contribution, write tests for it. Just create a new file under src/__tests__ or add additional tests to the appropriate existing file.
Before submitting your PR, run yarn test to make sure there are no (unintended) breaking changes.
The Zod documentation lives in the README.md. Be sure to document any API changes you implement.
By contributing your code to the zod GitHub repository, you agree to license your contribution under the MIT license.