Skip to content

chore: update CONTRIBUTING.md #270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
webfansplz merged 1 commit into from
Mar 28, 2026
Merged

chore: update CONTRIBUTING.md #270

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 42 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,20 @@ You can check the [TODO list](https://github.com/vitejs/devtools/issues/9) (excl

## Setup

Requires `pnpm@10.x`.

```bash
pnpm install
pnpm build # Required: generates Rolldown meta under ./packages/rolldown/node_modules/.rolldown
pnpm dev # Start dev server

# Start Rolldown devtools UI
pnpm dev:rolldown
# Start Vite devtools UI
pnpm dev:vite
# Core playground (host app with DevTools overlay)
pnpm play
# Standalone client dev
pnpm play:standalone
```

**Note**: After pulling latest commits, remove `./packages/rolldown/node_modules/.rolldown` and rebuild to get the latest data format.
Expand Down Expand Up @@ -42,8 +52,8 @@ Main entry point and core functionality.

Utility library for integration authors.

- TypeScript types and interfaces
- Utilities for custom docks, views, panels
- TypeScript types and interfaces for docks, views, panels
- `defineRpcFunction` and shared state utilities
- Event system utilities
- RPC client helpers

Expand All @@ -66,9 +76,21 @@ Built-in UI panel for Rolldown integration.

---

### `packages/vite` - `@vitejs/devtools-vite`

UI for Vite DevTools (WIP).

---

### `packages/ui` - `@vitejs/devtools-ui`

Shared UI components, composables, and UnoCSS preset (`presetDevToolsUI`).

---

### `packages/rpc` - `@vitejs/devtools-rpc`

RPC layer for component communication.
Typed RPC wrapper over `birpc` with WebSocket presets.

- RPC client/server implementations
- WebSocket presets
Expand All @@ -79,6 +101,12 @@ RPC layer for component communication.

---

### `packages/self-inspect` - `@vitejs/devtools-self-inspect`

Meta-introspection — DevTools for the DevTools itself.

---

### `packages/webext` - `@vitejs/devtools-webext`

Browser extension (planned for future dev mode). **Not accepting contributions currently.**
Expand All @@ -87,14 +115,16 @@ Browser extension (planned for future dev mode). **Not accepting contributions c

## Scripts

- `pnpm build` - Build all packages
- `pnpm watch` - Watch mode
- `pnpm dev` - Dev server
- `pnpm lint` - ESLint
- `pnpm build` - Build all packages (via turbo)
- `pnpm watch` - Watch mode for all packages
- `pnpm play` - Core playground (host app with DevTools overlay)
- `pnpm play:standalone` - Standalone client dev
- `pnpm dev:rolldown` - Rolldown UI dev server
- `pnpm dev:vite` - Vite UI dev server
- `pnpm docs` - VitePress docs dev server
- `pnpm lint` - ESLint (pass `--fix` to auto-fix)
- `pnpm test` - Vitest
- `pnpm typecheck` - Type check

Package-specific: `pnpm -C packages/core run cli`, `pnpm -C packages/rolldown run dev`
- `pnpm typecheck` - vue-tsc type check

## Workflow

Expand All @@ -107,5 +137,5 @@ Package-specific: `pnpm -C packages/core run cli`, `pnpm -C packages/rolldown ru

- **core**: CLI in `cli-commands.ts`, server in `server.ts`, components in `client/webcomponents/`
- **kit**: Keep APIs stable, add types for public APIs, consider backward compatibility
- **vite**: Nuxt 3 app, Vue 3 Composition API, test with `pnpm dev` after build
- **vite**: Nuxt 4 app, Vue 3 Composition API, test with `pnpm dev` after build
- **rpc**: Keep methods type-safe, document new methods, test client/server
Loading