term_ui

# Contributing to TermUI

See [Community and examples](guides/community.md) for discussion, issue
reports and example contributions.

Use `main` as the pull request target for v2 work. Use `maint/1.x` for v1
fixes. Base each change on its target branch. Keep changes focused and include
tests for behavior changes. Keep the two version lines separate. `develop`
is a historical v1 integration branch; new work uses the supported targets.

Before you submit a pull request, run:

```bash
mix deps.get
mix quality
mix coveralls
mix spex
mix deps.unlock --check-unused
mix hex.audit
mix docs --warnings-as-errors -f html
mix hex.build
```

TermUI uses the shared v5 Jido CI, review, and release workflows, pinned to
reviewed commits. Dependabot checks dependencies each week for both supported lines:
`maint/1.x` and `main`. Use Conventional Commits. Do not edit `CHANGELOG.md`
in a normal pull request. Release preparation can add reviewed version entries.
Use a `release/` source branch or a `chore(release):` PR title for that work.
The release changelog check still rejects a new Unreleased section.

Terminal lifecycle changes also need a manual check in a real terminal. Verify
normal exit, application failure, backend failure, and forced process exit.
After each case, confirm that cooked input, the cursor, style, paste mode,
focus events, mouse tracking, and the active screen are restored.

The supported runtime matrix is Elixir 1.18.4 or later on OTP 28 or later. CI
tests Elixir 1.18.4, 1.19, and 1.20 on OTP 28, and Elixir 1.20 on OTP 29.

See [Package quality](guides/package-quality.md) for the Jido standard and the
documented compatibility exceptions.

The current release checks and branch transition are in
[the v2 source transition record](https://github.com/agentjido/term_ui/blob/main/docs/releases/2026-09-30-v2-source-transition.md).
Hex publication is managed separately by the maintainer. Use the exact
reviewed `main` source for publication. The manual release caller publishes an
existing annotated tag through the shared Jido workflow. Tag pushes do not
publish. See [publishing](guides/publishing.md) for local login, the GitHub
secret, tag preparation, validation, and publication.

See [repository layout](guides/repository-layout.md) for the purpose of each
folder and the package file list. Local toolchain settings belong to the
contributor; the package and CI declare the supported versions. Run the existing
checks for an affected example from its own directory. Browser checks need
Node.js and Chromium; Ghostty checks need its supported native SDK.

The current version is `2.0.0-rc.1`, the first release candidate. It is not the
final 2.0 release. See [testing](guides/testing.md) for test groups and their
limits, and [the documentation plan](https://github.com/agentjido/term_ui/blob/main/docs/plans/2026-09-30-001-refactor-rc1-documentation-plan.md)
for the next guide work. Put plans in `docs/plans` and verified fixes in
`docs/solutions`. Public user instructions belong in `guides`.