openpencil/packages/docs/development/contributing.md

# Contributing

The root [`CONTRIBUTING.md`](https://github.com/open-pencil/open-pencil/blob/master/CONTRIBUTING.md) is the source of truth for setup, pull-request requirements, validation, and commit expectations. The root [`AGENTS.md`](https://github.com/open-pencil/open-pencil/blob/master/AGENTS.md) holds the repository map and cross-cutting conventions, and links the `AGENTS.md` guide inside each package or app domain. Read the root file and every guide on the path to the folder you change; coding agents pick them up the same way.

See [Architecture](/development/architecture) for the system overview and [Testing](/development/testing) for test ownership, fixtures, and commands. Use the root `AGENTS.md` map when exact package ownership or paths matter; do not infer ownership from an older copied tree.

## Quick start

```sh
bun install
bun run dev:portless # Editor at https://open-pencil.localhost
bun run docs:dev     # Docs at localhost:5173
```

The complete gate before a pull request is `bun run check`, `bun run format`, `bun run test:unit`, and `bun run test`. Rendering and other pixel-affecting changes require targeted visual coverage.

## SDK documentation

VitePress is the canonical public documentation, while Storybook is the internal component-state workshop. Shared Vue demos live beside their SDK primitives and are embedded in both surfaces. The docs Tailwind entry scans these demos, so examples use the same utility-first styling in both environments.

Component API tables are extracted from Vue source and JSDoc with `vue-component-meta`. Keep descriptions next to public props, events, and slots instead of duplicating signatures in Markdown. VitePress processes SDK examples with Twoslash so imports and types stay aligned with the public package API.
OpenSpec baseline specs, VitePress docs, Windows build support 2026-02-28 08:38:27 +00:00			`# Contributing`

docs: route contributors through per-domain guides and ship npm license text (#785) Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm. 2026-09-28 21:02:06 +00:00			The root [`CONTRIBUTING.md`](https://github.com/open-pencil/open-pencil/blob/master/CONTRIBUTING.md) is the source of truth for setup, pull-request requirements, validation, and commit expectations. The root [`AGENTS.md`](https://github.com/open-pencil/open-pencil/blob/master/AGENTS.md) holds the repository map and cross-cutting conventions, and links the `AGENTS.md` guide inside each package or app domain. Read the root file and every guide on the path to the folder you change; coding agents pick them up the same way.
OpenSpec baseline specs, VitePress docs, Windows build support 2026-02-28 08:38:27 +00:00
docs: route contributors through per-domain guides and ship npm license text (#785) Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm. 2026-09-28 21:02:06 +00:00			See [Architecture](/development/architecture) for the system overview and [Testing](/development/testing) for test ownership, fixtures, and commands. Use the root `AGENTS.md` map when exact package ownership or paths matter; do not infer ownership from an older copied tree.
docs: align contribution and review policy - Replace stale setup, package, test, and selector guidance\n- Keep public contributor docs linked to canonical repository policy\n- Disable CodeRabbit review decisions and generic docstring coverage 2026-09-01 17:58:14 +00:00
docs: route contributors through per-domain guides and ship npm license text (#785) Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm. 2026-09-28 21:02:06 +00:00			`## Quick start`
OpenSpec baseline specs, VitePress docs, Windows build support 2026-02-28 08:38:27 +00:00
			```sh
			`bun install`
docs: route contributors through per-domain guides and ship npm license text (#785) Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm. 2026-09-28 21:02:06 +00:00			`bun run dev:portless # Editor at https://open-pencil.localhost`
OpenSpec baseline specs, VitePress docs, Windows build support 2026-02-28 08:38:27 +00:00			`bun run docs:dev # Docs at localhost:5173`
			```

docs: route contributors through per-domain guides and ship npm license text (#785) Root AGENTS.md becomes a map plus cross-cutting rules; folder rules live in one AGENTS.md per package and top-level folder, checked by check:docs. CONTRIBUTING.md owns process; README and the docs page link to it. Release preparation copies the root LICENSE into every published package, Core, CLI, and MCP gain READMEs, and the release workflow test packs its fixture in-process instead of through npm. 2026-09-28 21:02:06 +00:00			The complete gate before a pull request is `bun run check`, `bun run format`, `bun run test:unit`, and `bun run test`. Rendering and other pixel-affecting changes require targeted visual coverage.
docs: align contribution and review policy - Replace stale setup, package, test, and selector guidance\n- Keep public contributor docs linked to canonical repository policy\n- Disable CodeRabbit review decisions and generic docstring coverage 2026-09-01 17:58:14 +00:00
			`## SDK documentation`

			`VitePress is the canonical public documentation, while Storybook is the internal component-state workshop. Shared Vue demos live beside their SDK primitives and are embedded in both surfaces. The docs Tailwind entry scans these demos, so examples use the same utility-first styling in both environments.`

			Component API tables are extracted from Vue source and JSDoc with `vue-component-meta`. Keep descriptions next to public props, events, and slots instead of duplicating signatures in Markdown. VitePress processes SDK examples with Twoslash so imports and types stay aligned with the public package API.