Definition of Done

This document defines the minimum completion bar for issues and pull requests in the KiCad Studio Kit monorepo.

Universal completion criteria

Every PR should satisfy the following before merge:

The PR references the issue it closes or advances.
The PR has one clear purpose and avoids unrelated cleanup.
Product-specific checks pass for every touched product.
Root checks pass when root tooling, shared packages, CI, release, or docs are touched.
Documentation is updated when behavior, commands, paths, compatibility, or release process changes.
Breaking changes include migration notes.
Compatibility metadata is updated when supported versions, MCP schema, or feature gates change.
Release notes are updated or explicitly marked not required.
Sensitive data is not logged, committed, or added to artifacts.

Bug fixes must include regression coverage.

Required evidence:

A test that fails before the fix and passes after the fix, when practical.
A related issue ID in the test name or test metadata.
A fixture, golden file, visual snapshot, or contract test when relevant.
The exact local or CI command that proves the regression now passes.
A note in the PR explaining any case where automation is not practical, with maintainer approval before the issue is closed.

Manual screenshots alone are not sufficient to close repeatable bugs.

Before closing a bug issue, maintainers should verify:

The linked PR includes a regression test or a documented maintainer-approved exception.
The regression evidence references the related issue ID in the test name, fixture metadata, snapshot name, or contract case.
The PR lists the command or CI check that ran the regression.
Repeatable visual bugs are covered by a visual, DOM, accessibility, or fixture-backed test instead of screenshot-only evidence.

Architecture changes must include:

Updated architecture documentation.
Boundary impact analysis.
Validation that product workspaces remain independently buildable.
No direct source imports between apps/vscode-extension, packages/mcp-server, and packages/mcp-npm.
No production source imports from @oaslananka/kicad-test-harness.
Migration notes for renamed or moved paths.

Protocol-impacting changes must complete the protocol change checklist in the pull request template and include:

User-facing UI changes must include:

State coverage for loading, empty, success, error, and degraded states where applicable.
Visual regression update or explanation when screenshots change.
Accessibility check or keyboard navigation coverage for interactive controls.
VS Code theme compatibility for dark, light, and high-contrast modes.

Release-impacting changes must include:

Coding-agent PRs must additionally include: