Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.19 KB
Raw

Contributing

CodexPro is early. Good contributions make it safer, faster, and easier to explain.

Local Setup

npm install
npm run build
npm run smoke

Run a local connector:

npm run connect:local -- --root /path/to/test/repo

Run through a Cloudflare quick tunnel:

npm run connect -- --root /path/to/test/repo --bash safe --write handoff

Useful Areas

  • safer tool defaults
  • better setup diagnostics
  • stable tunnel setup helpers
  • smaller/faster context bundles
  • clearer ChatGPT tool prompts
  • better Apps SDK widgets
  • tests for path guards and auth boundaries
  • docs that reduce user setup mistakes

Pull Request Checklist

  • Keep the change scoped.
  • Do not include local tunnel URLs, auth tokens, .env values, or private paths.
  • Run npm run build.
  • Run npm run smoke.
  • Update README.md or CHANGELOG.md when behavior changes.
  • Explain security impact for changes touching auth, file access, shell execution, or tunnels.

Docs Style

  • Be concrete.
  • Avoid hype.
  • Name the exact command, mode, flag, and failure case.
  • Make risk boundaries clear.
  • Prefer examples that use /path/to/repo and codexpro.example.com, not local machine paths.