Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

72 lines (43 loc) · 2.6 KB

Contributing to Bridg

Thank you for being interested enough in this project to open this 😉

I need all the help I can get, so if you spot anything you think you can improve, any PR's or even just opened issues would be extremely appreciated.

Getting Started

  1. Install Node.js >=16.13 minimum, latest LTS is recommended

    • Recommended: use nvm for managing Node.js versions

  2. Install pnpm (for installing npm dependencies, using pnpm workspaces)

  3. Install ts-node (for running Node.js scripts written in TypeScript)

Copy paste these commands to install the global dependencies:

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
nvm install --lts
npm install --global pnpm@8 ts-node

How this repo works

This repo consists of two packages /packages/generator and /packages/usage

Generator

/packages/generator is the main package, this get's installed on a user's machine when they npm install bridg.

This is a prisma generator, it runs a code generation step whenever the user runs npx prisma generate

The Bridg generator creates Typescript files based on the user's Prisma schema, then compiles those files into JavaScript and .d.ts files

Any new features, or changes to existing functionality will be made in this package.

Usage

/packages/usage is a test environment / playground for generating Bridg clients, for ensuring that generation and DB rules are working properly

Running Tests

The main test suite is located at ./packages/usage/__tests__/

To run tests:

cd packages/usage

# regen bridg test clients, if you've made changes to generator code
npm run test:prepare

# runs all tests
npm run test

# run integration tests (fast)
npm run test:int

# run only pulse tests (long running, requires Prisma Pulse API key)
npm run test:pulse

# install every version (5+) of Prisma, and run integration tests
# ensures that changes don't break for previous versions of Prisma
npm run test:prisma-versions

CLA

Pull Request authors must sign a contributor license agreement (CLA). Prisma has offered to let us to use their CLA for this.

For now, this must be done manually, but in the future, this will be added as an automated step whenever you open your first PR.