Open-Source Wikis

/

Prisma

/

How to contribute

prisma/prisma

How to contribute

Active contributors: jacek-prisma, Oleksii Orlenko, Kristof Siket, Søren Bramer Schmidt

The full external-facing rules live in CONTRIBUTING.md. This page summarizes them from the perspective of a contributor working inside the repo, with pointers to the deeper pages in this section.

Picking up work

Most non-trivial work tracks a GitHub issue. If you're picking up work yourself:

  1. Check the issues and discussions for an existing tracker.
  2. If you're a Prismanaut, you can attach /integration to your PR description to release a pre-release version to the npm integration tag (see Development workflow).
  3. Set up your sandbox project under sandbox/ for reproductions (see Getting started).

PR expectations

Quoting CONTRIBUTING.md and adapting:

  • Description — explain the change and link the tracking issue. Use /integration if you need a pre-release.
  • Tests — every change ships tests. Where they go depends on the change; see Testing.
  • CI — Lint, CLI commands, and All pkgs (win+mac) GitHub Actions must pass. CI lives in .github/workflows/test.yml plus the sub-workflows in the same directory.
  • Bundle size — the size-limit report 📦 comment must show packages/cli/build/index.js under ~6MB. Limits are configured in the root package.json size-limit array.
  • CLA — first-time contributors sign the Prisma CLA.

Commit message format

<type>(<package>): <subject>

<body>

Types: feat, fix, docs, style, refactor, perf, test, chore. Package matches the directory name under packages/. Example: feat(client): add accelerateUrl option to constructor.

Definition of done

A change is done when:

  1. Source compiles (pnpm build or pnpm dev) without errors.
  2. Lint is clean (pnpm lint).
  3. Tests for the affected package pass (pnpm --filter @prisma/<pkg> test [pattern]).
  4. CI green on the PR.
  5. PR description references the issue and lists any user-visible behavior change.
  6. If a change adds knowledge that future agents would want, AGENTS.md is updated. This is not optional for behavior changes — the AGENTS.md file is the running knowledge base.

Sub-pages

  • Development workflow — branch / build / test / PR / merge cycle, including pre-release tags
  • Testing — Jest vs Vitest, functional matrix, e2e, integration, fixtures
  • Debugging — debugging recipes for the CLI, the client runtime, generators, and Studio
  • Patterns and conventions — coding style, error handling, file naming
  • Tooling — esbuild build pipeline, Turborepo, ESLint local rules, Prettier

Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.

How to contribute – Prisma wiki | Factory