HHostingByteSoftware
Ctrl K
ComunidadGuías…

CONTRIBUTING.md

Rama main · réplica de lectura del repositorio original.

Archivo original ↗Preguntar a KiBot
# Contributing to Home Assistant Codex Bridge

This repository contains a Home Assistant Integration, a private Bridge
service, and a stable, `amd64`-only Supervisor App. Preserve the boundary: browsers
talk to Home Assistant; Home Assistant talks privately to the Bridge; Codex
works only in an explicitly granted workspace.

## Before opening an issue or pull request

- Read [CONTEXT.md](CONTEXT.md) for shared product language and
  [AGENTS.md](AGENTS.md) for repository-wide engineering and release rules.
- Use [SUPPORT.md](SUPPORT.md) for setup and usage questions.
- Use [SECURITY.md](SECURITY.md) for potential vulnerabilities; do not disclose
  them in a public issue.
- Search existing issues and keep proposed changes narrowly scoped.
- Do not include device codes, tokens, cookies, credentials, private workspace
  paths, customer data, or raw logs that may contain them.

## Development expectations

1. Start from the current default branch and keep unrelated changes out of the
   pull request.
2. Explain the user-visible behavior, trust boundary, and compatibility impact.
3. Add or adjust regression tests for behavior changes.
4. Update documentation and `codex_bridge_app/CHANGELOG.md` when installation,
   authentication, workspace, model, security, update, recovery, or uninstall
   behavior changes.

The current paired release is App, Integration and panel `1.13.25` (`amd64`),
Bridge `0.20.1` and Codex `0.166.0`. Update both the Supervisor App and the
HACS Integration, then restart Home Assistant and refresh the panel. App-only
fixes may use a different App version when they do not change the negotiated
API or panel. See the [changelog](codex_bridge_app/CHANGELOG.md) for the
behaviour included in each release.

The prior signed and target-HA-accepted `0.8.11` App/Integration/panel release
uses Bridge `0.7.6` and Codex `0.144.5`, exact main commit
`5387a2abcdeac3a5a3c01fe96876634af56542ad`, publication workflow
`29633146637`, and immutable image digest
`sha256:1e69b2db3b223f3e60bc00ce463ae9c5a941d9492c5149ff95eaa1f890deab85`.
Its signature, SBOM, provenance, account-switch behavior, and preserved local
chat history were verified. Target acceptance for PDF list/archive/preview/
download, external blocked-network routing, cold restore, arbitrary prior-image
rollback, and the secure App-owned browser worker remains unproven. A source
checkout, local image, or unit test is not release evidence.

## Local checks

Use Node.js 24 for panel development, matching CI. The supported development
versions are Node.js 22.x from 22.13, 24.x, and 26+ as declared in `package.json`;
Node.js 20 and 25 are not supported by the current Vitest 5 toolchain.
This tooling requirement does not change the installed Home Assistant runtime.

```powershell
# Home Assistant Integration (run in Linux, matching CI)
python -m pytest -q
python -m mypy --strict -p custom_components.codex_bridge

# Bridge suite (isolated from the Home Assistant pytest plugin)
$env:PYTEST_DISABLE_PLUGIN_AUTOLOAD = "1"
python -m pytest -q bridge_service\tests -p pytest_asyncio.plugin -p pytest_timeout

python -m compileall -q bridge_service\src custom_components
node --check custom_components\codex_bridge\frontend\codex-bridge-panel.js
```

Run the full Bridge suite from a native Linux checkout as an unprivileged user;
only `bridge_service/tests/test_app_restore_repair.py::test_cold_restore_repairs_only_app_owned_state_and_preserves_bytes`
requires root. Before the full suite, check that the selected Python 3.14 build
exposes `fcntl.F_ADD_SEALS`, `F_SEAL_SEAL`, `F_SEAL_SHRINK`, `F_SEAL_GROW`, and
`F_SEAL_WRITE`. This is a capability check for the runtime in use, not an
assumption about every Python 3.14 or uv-provided build. Also confirm that a
child Python process starts with `LD_LIBRARY_PATH` and `PYTHONHOME` absent, as
the Bridge deliberately removes those variables from supervised processes.

For an App, Supervisor, sandbox, proxy, or image change, state exactly which
target-system checks were performed and what remains. Never weaken the sandbox,
mount broader filesystems, expose a Bridge port, or add API-key login merely to
make a test pass.

## Dependency updates

Dependabot can queue individual stable patch/minor updates for the development
tools allowlisted in `scripts/dependabot_automerge_policy.mjs`. The trusted-base
workflow checks the manifest, lockfile graph and current reviews; GitHub's
required checks and pull-request protections still control the merge.
Run `npm run test:dependabot-policy` when changing this policy.

Runtime packages, `esbuild`, `pdfjs-dist`, Python and Docker updates remain
manual, as do major, prerelease, grouped or maintainer-edited updates. A tool
update that also changes a dependency used by runtime or bundle generation is
not eligible. Weekly manual groups reduce notification noise without relaxing
these checks. This policy does not publish a release or update an installation.

## Documentation style

Use the terms in [CONTEXT.md](CONTEXT.md). Write the exact UI labels **Sign in
with ChatGPT**, **Cancel**, and **Sign out**. State that normal signed-in panel
use remains on Home Assistant, while initial sign-in and re-authentication need
browser access to the approved ChatGPT device-auth page.

For catalogue changes, preserve dynamic runtime discovery: stale data retries
after 15 seconds, a verified last-known-good record precedes the installed
Codex bundled catalogue, and static fallback is last. Do not hardcode GPT-5.6,
Max, Ultra, or any other model-specific option. For panel changes, preserve the
compact Codex-style sidebar and the typed transient artifact-reservation path,
including prior-artifact preservation when the selected chat is idle.

For capability surfaces, preserve these boundaries:

- Home Assistant owns automation timing; Bridge claims are revision-checked and
  idempotent, and skipped overlap/capacity/misfire outcomes remain visible.
- Skills and plugins stay scoped to the selected workspace and runtime
  configuration. Marketplace sources are HTTPS-only and must not contain
  credentials or private addresses.
- Global/project `AGENTS.md` writes are bounded, atomic, and backed up in
  private storage. Do not turn instruction files into a filesystem escape.
- MCP is outbound streamable HTTP to a trusted HTTPS endpoint. Preserve the
  best-effort rejection of known non-public DNS answers. Do not add a
  browser-facing MCP/App port, bearer-token setting, or persisted OAuth URL;
  preserve explicit OAuth and decline-only elicitation behavior.