Skip to content

Contributing

Keep modules focused, preserve backend boundaries and run the relevant checks.

On this page

Inrux is early alpha. Bug reports, API feedback, reproducible native rendering/input issues and focused contributions are welcome. Open an issue before a large architectural change so the public contracts can be discussed first.

Code organization

  • Framework crates belong in packages/; developer tools in tooling/; runnable examples in playground/.
  • Keep modules focused. Do not put an entire subsystem into one file. Framework components use components/<component-name>/<component-name>.rs with focused sibling modules when needed.
  • Document public APIs and explain non-obvious lifetime, threading and performance choices. Comments should explain the reason for complex logic.
  • Keep component behavior independent of GUI engines. Engine imports, handles and private rendering resources belong in backend crates.
  • Components supply behavior, keyboard/pointer interaction and minimal overridable defaults. Themes and showcase recipes belong to applications.
  • Reuse Rust/Cargo and suitable existing libraries instead of duplicating build, watch or layout infrastructure.
  • Keep the public facade small and coherent. New utilities need a clear owning module/crate and a README when they form a separate package.
  • Portable playground edits must stay consistent across all three projects. Engine-only bootstrap differences stay in src/engine.rs and relevant native tests.
  • Update public documentation when changing behavior, syntax, support or examples. Do not advertise proposed APIs as implemented.

Setup and checks

Follow getting started for native prerequisites. From the repository root:

sh
cargo fmt --all -- --check
cargo test --workspace --all-features --locked
python3 tooling/backend-check/check.py
python3 tooling/playground-check/check.py
cargo test -p inrux-adapter --no-default-features --locked
cargo test -p inrux --no-default-features --locked
cargo check -p inrux --no-default-features --features masonry --locked
cargo check -p inrux --no-default-features --features gpui-runtime-shaders --locked
cargo clippy --workspace --all-targets --all-features --locked -- -D warnings

For editor changes:

sh
npm ci --prefix tooling/inrux-vscode
npm run check --prefix tooling/inrux-vscode
npm run test:unit --prefix tooling/inrux-vscode

The extension README explains host-test prerequisites and limitations. Run native applications for changes to focus, editing, scrolling, painting or accessibility; unit tests cannot establish the full UX. Report checks you could not run. CI configuration is in .github/workflows/ci.yml.

Keep behavioral tests meaningful: cover failure/lifetime boundaries and observable results. A docs-only edit does not need a new runtime test. Benchmark optimizations under comparable native/framework workloads; include costs of translation, duplicate layout work, caching and allocations.

Submitting changes

Explain the problem, resulting behavior and validation. Keep unrelated changes separate. Preserve third-party copyright/license notices when adapting upstream code. Original contributions are MIT-licensed under LICENSE; third-party material retains the terms listed in THIRD_PARTY_NOTICES.md.

The architecture, authoring contract and current status are the public references for review.

On Windows, use py -3 in place of python3 for Python consistency checks.

Inrux · Built with Nuxt Content, IPEX, and Akaza UI.