Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (27 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

39 lines (27 loc) · 1.64 KB
Raw

Contributing

Thanks for helping make this compatibility layer safer and easier to use.

Before opening an issue

  • Search existing issues.
  • Confirm the CC Switch route service is enabled.
  • Run PYTHONPATH=src python3 -m codex_ccswitch_search_split --status.
  • Reproduce with the latest project version when practical.
  • Remove credentials, account IDs, prompts, responses, private URLs, local usernames, and personal paths from all output.

Never attach auth.json, a CC Switch database, an unredacted Codex config, a packet capture, or full proxy logs.

Development setup

Python 3.11 or newer is required. The runtime has no third-party dependencies.

python3 -m compileall -q src tests
PYTHONPATH=src python3 -m unittest discover -s tests -v
bash -n scripts/install-macos.sh scripts/uninstall-macos.sh

Pull requests

  • Keep changes focused.
  • Add or update standard-library unittest coverage.
  • Preserve the loopback default and OAuth destination allowlist.
  • Do not add request/header/body logging, even behind a debug flag.
  • Do not read CC Switch provider credentials or databases.
  • Keep the runtime dependency-free unless there is a compelling, reviewed security reason.
  • Update both README files for user-facing behavior.

Use synthetic fixtures only. A test secret should look obviously fake and must not resemble a live token.

Compatibility reports

Because the standalone search endpoint is experimental, a useful report includes the Codex version, project version, operating system, whether model routing still works, and the redacted HTTP status/error type. It should not include request contents or authentication material.