Skip to content

Latest commit

 

History

History
30 lines (17 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 1.24 KB

Contributing Guide

Hi! We are really excited that you are interested in contributing to @vite-pwa/vitepress. Before submitting your contribution, please make sure to take a moment and read through the following guide.

Refer also to https://github.com/antfu/contribute.

Set up your local development environment

The @vite-pwa/vitepress repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be pnpm.

To develop and test the @vite-pwa/vitepress package:

  1. Fork the @vite-pwa/vitepress repository to your own GitHub account and then clone it to your local device.

  2. Ensure using the latest Node.js (16.14+)

  3. @vite-pwa/vitepress uses pnpm v7. If you are working on multiple projects with different versions of pnpm, it's recommend to enable Corepack by running corepack enable.

  4. Check out a branch where you can work and commit your changes:

git checkout -b my-new-branch

  1. Run pnpm i in @vite-pwa/vitepress's root folder

  2. Run pnpm run build in @vite-pwa/vitepress's root folder.

Testing changes

From the terminal, change to one of the examples folder and run pnpm run build && pnpm run preview.