Thanks for helping make .design the living visual contract for AI design.
- SPEC.md is normative. Schema, skill, examples, and docs must follow it.
- No in-file history / proposal queues. Git is the audit trail.
- DESIGN.md parity. Do not drop component properties or rationale sections on import/export.
- Examples disclaimer. Brand examples from getdesign.md are independent analyses — not affiliated with those companies.
- Keep PRs focused. Spec change, schema, skill, examples, or docs — prefer separate commits when mixing.
1. Edit SPEC.md (if format changes)
2. Sync schema/design.v1.schema.json
3. Update skills/design/ references
4. Refresh examples if needed:
python scripts/convert_getdesign.py
5. Validate everything:
python scripts/lint_design.py
6. Update docs/ (especially diagrams)
7. Open a PR — CI runs the same validation plus a leak guard
| Script | Purpose |
|---|---|
scripts/lint_design.py |
Schema + SPEC §19 lint over all examples/templates (runs in CI) |
scripts/export_design.py |
Emit exports.* artifacts: CSS variables (mode strategies), Tailwind v4 @theme, DTCG JSON, shadcn registry item |
scripts/diff_design.py |
SPEC §18 diff: added/removed/modified per token group + regression flag (--fail-on-regression) |
scripts/convert_getdesign.py |
Regenerate brand examples from DESIGN.md analyses |
pip install pyyaml jsonschema
python scripts/lint_design.py
python scripts/export_design.py templates/starter.design --out-dir /tmp/exports
python scripts/diff_design.py old.design new.design --fail-on-regressionRequires temporary DESIGN.md downloads (gitignored):
# download sources into .tmp-*-DESIGN.md (see scripts/convert_getdesign.py BRANDS)
python scripts/convert_getdesign.py
python scripts/lint_design.py- Hub: docs/INDEX.md
- Ecosystem: docs/ecosystem.md
- Prefer Mermaid diagrams for architecture / flows
See CODE_OF_CONDUCT.md.
By contributing, you agree your contributions are licensed under the MIT License.