BREAD / GUIDES
Contributing
Make a bounded, reproducible improvement with evidence of its scope.
Run the checks
Use the pinned Node version in .nvmrc. verify runs strict typechecking, core/CLI/DOM tests and two clean byte-identical static builds. Browser checks cover desktop and phone-sized Chromium; install any required OS browser dependencies for your environment.
The docs build compiles its sample previews from the exact examples/*.bread sources. Link and example checks prevent source/render drift. English and Japanese guides live together in docs-site/content.ts.
npm ci --ignore-scripts
npm run verify
npx --no-install playwright install chromium
npm run test:browserPropose evidence, not unbounded claims
New components need concrete pin identities, source dimensions, license provenance, footprint assumptions, explicit supported topology, error behavior and independent physical verification. Include honest limits and reviewable screenshots.
Keep identifiers and error codes stable. Localization must not alter user source or exported diagrams. Use textContent for untrusted diagnostic detail; keep CSP and worker boundaries intact.
Open a focused pull request. No publication, deployment or merge follows automatically from passing checks. See the repository CONTRIBUTING.md for the contribution policy.