Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (26 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.16 KB
Raw

CONTRIBUTING

We welcome contributions from everyone!

Getting started

Make sure you have Node.js and mise installed.

  1. Fork this repository and clone your fork
  2. Install pnpm via mise: mise install
  3. Install dependencies: pnpm install
  4. Install browsers for E2E test: pnpm setup

Build

Run the build with the following command:

pnpm build

Running tests

Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected.

Unit test

This project uses Vitest for the unit test. Run the test with the following command:

  • Run all test suites but watch for changes and rerun tests when they change: pnpm test:unit
  • Perform a single run without watch mode: pnpm test:unit run

E2E test

This project uses Playwright for the end-to-end test.

  • In all available and supported browsers: pnpm test:e2e
  • In a specific browser: pnpm test:e2e --project=chromium, pnpm test:e2e --project=firefox, etc.

You can use pnpm test:e2e:skipbuild to skip the build if you are sure it has already been built.