Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 824 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 824 Bytes
Raw

Contributing

Local Setup

  1. Install dependencies:
npm install
  1. Build the app:
npm run build
  1. Run the smoke suite:
npm test
  1. Start the development dashboard and backend:
npm run dev

Change Guidelines

  • Keep the bridge local-first and avoid widening network exposure by default.
  • Preserve per-account CODEX_HOME isolation.
  • Prefer targeted tests when touching request shaping, auth handling, or dashboard state.
  • Update the README when behavior, setup, or service commands change.
  • Do not commit .env, .local-data, build output, or account auth files.

Pull Requests

  • Keep PRs focused.
  • Include a short summary of user-facing changes.
  • Mention how the change was validated.
  • Include screenshots for dashboard/UI changes when relevant.