wehub-resource-sync
91e75e620b
CI: cua-driver distro-compat matrix / Resolve release version (push) Waiting to run
CI: cua-driver distro-compat matrix / debian:12 (glibc 2.36) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / fedora:41 (glibc 2.40) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / rockylinux:9 (glibc 2.34) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:22.04 (glibc 2.35) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / ubuntu:24.04 (glibc 2.39) (push) Blocked by required conditions
CI: cua-driver distro-compat matrix / Distro compat summary (push) Blocked by required conditions
CI: Nix Linux Rust source / Nix / compositor build (push) Waiting to run
CI: Nix Linux Rust source / Nix / driver package (push) Waiting to run
CI: Nix Linux Rust source / Nix / Rust unit tests (push) Waiting to run
CI: Rust Linux unit / Rust Linux unit and compile (push) Waiting to run
CI: Rust Windows unit / Rust Windows unit and compile (push) Waiting to run
CI: SPDX Headers / Check SPDX headers (warn-only) (push) Waiting to run
CD: Docs MCP Server / build (linux/amd64) (push) Waiting to run
CD: Docs MCP Server / build (linux/arm64) (push) Waiting to run
CD: Docs MCP Server / merge (push) Blocked by required conditions
68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
# Contributing to Cua
|
|
|
|
Thanks for contributing to Cua. The repository includes Python and TypeScript
|
|
SDKs, a Rust desktop driver, Swift virtualization tools, container images, and
|
|
public documentation. Start with the component that owns the behavior you want
|
|
to change.
|
|
|
|
## Report a Bug
|
|
|
|
Before opening an issue, search the existing issue tracker. Include:
|
|
|
|
- a concise description and reproducible steps;
|
|
- expected and actual behavior;
|
|
- Cua package or driver version;
|
|
- operating system, window system, and application when relevant;
|
|
- logs, structured errors, screenshots, or recordings that help reproduce it.
|
|
|
|
Do not include credentials or private application data.
|
|
|
|
## Propose a Change
|
|
|
|
For feature requests, describe the user problem and the expected behavior
|
|
before prescribing an implementation. Mention affected platforms and existing
|
|
workarounds when known.
|
|
|
|
## Submit Code
|
|
|
|
1. Read [`Development.md`](Development.md) and the guide next to the component.
|
|
2. Keep changes scoped to the component that owns the behavior.
|
|
3. Add or update tests that observe the public effect of the change.
|
|
4. Run the applicable commands in [`TESTING.md`](TESTING.md).
|
|
5. Run the formatters and linters owned by the changed component.
|
|
6. Open a focused pull request that explains behavior, validation, and known gaps.
|
|
|
|
Root pre-commit hooks are optional local helpers. Install them with:
|
|
|
|
```bash
|
|
uv sync --group dev
|
|
uv run pre-commit install
|
|
```
|
|
|
|
Mypy is configured but is not currently a pre-commit gate. Rust, TypeScript,
|
|
Swift, and documentation checks remain component-owned.
|
|
|
|
## Desktop Behavior Changes
|
|
|
|
cua-driver behavior must be verified through the canonical Rust harnesses. A
|
|
successful tool response alone is not evidence that an action reached the
|
|
application. Delivery tests should observe fixture state and attach focus,
|
|
z-order, cursor, leaked-input, capture, or refusal oracles as required.
|
|
|
|
Do not weaken a test to match the current driver. Add a capability, return an
|
|
exact structured refusal, or record the behavior as an explicit gap.
|
|
|
|
## Documentation
|
|
|
|
Public documentation lives under `docs/content/docs` and follows Diataxis. See
|
|
[`docs/README.md`](docs/README.md) before adding a page. Contributor-only plans,
|
|
journals, and implementation notes belong next to their component.
|
|
|
|
Documentation changes should pass generator drift, hygiene, internal links,
|
|
and the production Fumadocs build.
|
|
|
|
## Community
|
|
|
|
For design discussion and contributor help, join the
|
|
[Cua Discord community](https://discord.com/invite/mVnXXpdE85).
|