Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 2.12 KB

File metadata and controls

71 lines (54 loc) · 2.12 KB

Contributing

Thanks for helping make Codex Micro support on Linux less adventurous.

Scope

Good contributions include:

  • compatibility updates for new Codex desktop Linux overlay builds;
  • safer detection, backup, verification, and rollback logic;
  • additional NixOS architectures or reproducible runtime configurations;
  • sanitized diagnostics and confirmed compatibility reports;
  • documentation corrections.

Please keep standalone agent/shell bindings in micro-herdr. This repository is specifically for native Codex desktop integration.

Ground rules

  • Do not commit Codex app bundles, ASAR files, Work Louder packages, firmware, device-kit code, or other proprietary artifacts.
  • Do not upload secrets, account data, full application logs, or personally identifying filesystem paths.
  • Preserve reversible behavior. A patch must have status, apply, verification, and restore paths.
  • Refuse unknown bundle states instead of broadening a regular expression until it happens to match.
  • Document the exact app, overlay, Electron, architecture, and dependency versions used for a compatibility claim.

Development setup

Python 3.10+ is sufficient; the tools use only the standard library.

git clone https://github.com/cartermccann/codex-micro-linux.git
cd codex-micro-linux
make check

Updating for a new app build

  1. Start from an unmodified overlay.
  2. Record the Codex app, Electron, and overlay versions.
  3. Run every tool’s status action.
  4. Inspect changed feature-gate call sites and native-module paths.
  5. Update exact match counts and tests.
  6. Apply against a disposable overlay copy.
  7. Test idempotence and full restore.
  8. Test on a fresh Electron main process.
  9. Report each verification layer separately; do not infer dictation success from native-module loading.

Pull requests

Include:

  • the problem and observed error;
  • affected versions and architecture;
  • why the change is narrowly scoped;
  • test output;
  • apply/restore evidence;
  • sanitized log excerpts where useful.

Run before opening a PR:

make check
git diff --check