Contribute

Make a focused change. Prove the complete path.

ForgeUI spans a React and TypeScript Studio, generated native LVGL, ESP-IDF integration and physical hardware. A contribution is complete when every affected layer remains coherent.

Contribution workflow

1. Fork and branch

Use your own GitHub fork and a focused feat/, fix/ or docs/ branch.

2. Implement narrowly

Preserve current architecture, generated-code boundaries and proven hardware behaviour.

3. Test every affected layer

Run the repository checks and state the board, display and workflow tested.

4. Open a precise pull request

Explain the problem, approach, validation, limitations and any hardware evidence.

Full-stack contract

A browser feature is not a finished embedded feature

Controls and components must survive the entire Studio-to-firmware path.

Component definitionStudio paletteCanvas renderingInspectorPreviewPersistenceLVGL exportGenerated APITestsDocs

Pull request expectations

Keep changes focused; add tests and documentation; avoid unrelated refactors; state exact hardware validation and known limitations.

  • No secrets or private paths
  • No unverified support claims
  • No edits to developer-owned files during regeneration
  • Generated output changes include exporter tests

Generated-code ownership

Studio-generated UI and developer application logic are deliberately separate. Contributions must preserve that contract.

Open guide →