Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (28 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 1.56 KB

Contributing

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.

When reporting a bug, create a test

When you report a bug, it's helpful to include in the description a failing test that you expect to pass

Alternatively, you can provide a GitHub repository with a minimal reproduction

Create a GitHub issue before creating a PR

Please create a GitHub issue before creating a PR. This gives us a chance to discuss wether the change is needed and discuss the approach.

Creating a PR

The following steps will get you setup to contribute changes to this repo:

  1. Fork this repo.

  2. Clone your forked repo: git clone git@github.com:{your_username}/nestjs-zod.git

  3. Run pnpm i to install dependencies.

Directory structure

This repository is a monorepo and includes several packages under the packages directory:

  1. cli - This is a command line utility that can be used to automatically setup nestjs-zod
  2. example - A basic example of using nestjs-zod
  3. example-dual-zod - An example that uses both zod v4 and v3
  4. nestjs-zod - The main package
  5. z - Deprecated package that should not need any changes

Tests

Please write tests for any PR you create

Documentation

The nestjs-zod documentation lives in the README.md. Be sure to document any API changes you implement.

License

By contributing your code to the nestjs-zod GitHub repository, you agree to license your contribution under the MIT license.