Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (43 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 1.4 KB
Raw

Contributing

Contributions are welcome. Here's how to get started.

Setup

  1. Fork the repo on GitHub.
  2. Clone your fork and install dependencies:
git clone https://github.com/<your-username>/prisma-extension-kysely.git
cd prisma-extension-kysely
npm ci

Development Workflow

Build

npm run build

Compiles both ESM and CJS outputs to dist/.

Test

npm test

Runs Vitest against a SQLite database. The pretest script automatically runs prisma db push to set up the test DB.

Lint & Format

# Check for issues
npm run check

# Auto-fix
npm run check:write

Uses Biome for linting and formatting.

Commit Conventions

This project uses Conventional Commits. Commit messages are enforced by commitlint.

# Interactive commit prompt
npm run commit

Examples: fix: handle null result, feat: add postgres dialect support, docs: update readme.

Pull Requests

  1. Fork the repo and create a branch from main.
  2. Make your changes.
  3. Ensure npm test and npm run check pass.
  4. Open a pull request with a clear description of what changed and why.

Reporting Issues

Use the issue templates for bug reports and feature requests.