Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.35 KB
Raw

Contributing Guide

Hi! We are really excited that you are interested in contributing to vuetify-nuxt-module. 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 vuetify-nuxt-module repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be pnpm.

To develop and test the vuetify-nuxt-module package:

  1. Fork the vuetify-nuxt-module repository to your own GitHub account and then clone it to your local device.

  2. vuetify-nuxt-module uses pnpm v8. If you are working on multiple projects with different versions of pnpm, it's recommend to enable Corepack by running corepack enable.

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

git checkout -b my-new-branch

  1. Run pnpm install in vuetify-nuxt-module's root folder

  2. Run nr dev:prepare in vuetify-nuxt-module's root folder.

  3. Run nr dev in vuetify-nuxt-module's root folder.