Contributing

Contributions are welcome! Here is how you can help.

Developing Locally

  1. Fork and Clone the repository.
  2. Install Dependencies:

    npm install

  3. Start Watch Mode:

    npm run dev

Testing

This project uses vitest for testing. Tests are located in the __tests__ directory and often run against sample schemas in the prisma/ folder.

To run tests:

npm run test

To run a specific test suite (e.g., related to many-to-many relationships):

npm run test -- -t many

Debugging Contributions

When working on the generator code, enabling debug logs is helpful:

ERD_DEBUG=true npm run test

Pull Requests

Please link the issue you are solving in your PR. We use all-contributors to credit authors.