Files
breeze/CONTRIBUTING.md
T
waozi 71dcef992b Describe Lumi's optional online AI in the privacy policy and README
The policy now says what Lumi sends online and where, how feedback and
Telegram messages are kept, and how to stay offline or withdraw; the
README points to it and adds contributing and security reporting.
2026-10-19 18:40:31 -03:00

1.6 KiB

Contributing to Inner Breeze

Report a bug through Lumi's feedback card in the app or GitHub Issues. Include the app version, platform, steps to reproduce, what you expected, and what happened. Keep account keys, private conversations and personal practice data out of public reports. For a security issue, use Security.

Development

Build with make native cells. Dependencies and the Ziran toolchain are pinned in ziran.lock; see README for other platforms. Read AGENTS.md for repository conventions and app packages for module ownership.

Keep a change focused. Put app UI in its owning package, reusable Kryon changes in Kryon, and compiler changes in Ziran. Preserve existing data and upgrade paths. Translate changed app strings in every supported locale.

Run the tests that exercise the changed behavior and git diff --check. For UI changes, run make clean-text-api-check button-api-check and the relevant private-display UI tests. make test and make visual-test are the CI gates. Android adapter tests need Java 17 and Android SDK platform 36; set ANDROID_SDK_ROOT to your SDK directory. Visual tests create disposable profiles and private displays; they must never use your desktop or personal profile. See verification for the additional exact-source phone and release checks.

In a pull request, explain the user-visible change and list the checks you ran, including any platform you could not verify. A build or a commit does not publish a release.