Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions docs/guide/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,41 @@

> Hi! We're really excited that you're interested in contributing to Vue DevTools! Before submitting your contribution, please read through the following guide.

## Monorepo
## Development Setup

The Vue DevTools repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/).
After cloning the repo, run in the root folder.
You will need [Node.js](https://nodejs.org) **version 18.12+**, and [PNPM](https://pnpm.io) **version 8+**.

```sh
pnpm i
We also recommend installing [@antfu/ni](https://github.com/antfu/ni) to help switching between repos using different package managers. `ni` also provides the handy `nr` command which running npm scripts easier.

After cloning the repo, run:

```bash
$ pnpm i # install the dependencies of the project
```

## Development
## Git Hooks

The project uses [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) to enforce the following on each commit:

- Automatically format changed files using ESLint

### Setup
## Development

Build the project by
Build the project with watch mode:

```sh
pnpm dev
```

And then run the playground
OR

Build the project with:

```sh
pnpm build
```

And then run the playground:

```sh
pnpm play
Expand Down
3 changes: 3 additions & 0 deletions packages/browser-extension/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Browser extension

> DevTools Browser extension, coming soon...
3 changes: 3 additions & 0 deletions packages/client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# DevTools Client

> Client for DevTools.
3 changes: 3 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @vue/devtools-core

> Internal core functions shared across @vue/devtools packages.
7 changes: 7 additions & 0 deletions packages/devtools-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# @vue/devtools-api

> Plugins API for easier DevTools integrations.

## Getting Started

Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/plugins/api).
3 changes: 3 additions & 0 deletions packages/devtools-kit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @vue/devtools-kit

> Utility kit for DevTools.
7 changes: 7 additions & 0 deletions packages/devtools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# @vue/devtools

> This package provides a standalone vue-devtools application, that can be used to debug any Vue app regardless of the environment. Now you can debug your app opened in mobile browser, safari, native script etc. not just desktop chrome or firefox.

## Getting Started

Please follow the documentation at [devtools-next.vuejs.org](https://devtools-next.vuejs.org/guide/standalone).
3 changes: 3 additions & 0 deletions packages/electron/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Electron

> DevTools Electron App, used in [@vue/devtools](../devtools/README.md).
3 changes: 3 additions & 0 deletions packages/schema/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @vue/devtools-ui

> UI kit for DevTools.
3 changes: 3 additions & 0 deletions packages/shared/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @vue/devtools-shared

> Internal utility types shared across @vue/devtools packages.
3 changes: 3 additions & 0 deletions packages/ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# @vue/devtools-ui

> UI kit for DevTools.
31 changes: 31 additions & 0 deletions packages/vite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# vite-plugin-vue-devtools

> `vite-plugin-vue-devtools` is a `Vite` plugin designed to enhance the `Vue` developer experience.

## Installation

```sh

npm add -D vite-plugin-vue-devtools

```

## Usage

### Configuration Vite

```ts
import { defineConfig } from 'vite'
import VueDevTools from 'vite-plugin-vue-devtools'

export default defineConfig({
plugins: [
VueDevTools(),
vue(),
],
})
```

## Documentation

Check out all the DevTools details at [devtools-next.vuejs.org](https://devtools-next.vuejs.org).