Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

29 lines (16 loc) · 1.19 KB
Raw

Preview.js Contributing Guide

Hello! Thank you for considering contributing to Preview.js :)

This contributing guide is quite rudimentary at the moment, feel free to suggest improvements.

Before you start, please review the Contributor Assignment Agreement. You will need to sign it before your PR can be merged.

Repo Setup

This is a monorepo managed by pnpm using Turborepo to manage builds:

  • Ensure you have pnpm installed.
  • Run pnpm i from the root.
  • Build all packages by running pnpm turbo build.

Running Tests

Unit tests are run with Vitest whereas end-to-end tests are run with Playwright.

You can run all unit tests across the monorepo with pnpm turbo test, or you can run tests for a given package with pnpm test from its directory.

Each framework plugin has its own end-to-end tests, which can be run with pnpm e2e-test.

Working with the VS Code extension

In Visual Studio Code, hit F5 or click ▶️ VS Code Extension in the "Run and Debug" panel.

Note that the OSS implementation of Preview.js is a simpler webview than the official packaged extension.