Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (41 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1.49 KB

Contributing to CodexOpsStudio

Thanks for considering a contribution.

Before you start

  • The project is currently macOS-only.
  • The app is built with SwiftUI + AppKit and uses Codex CLI as a local dependency.
  • Please open an issue before starting large architectural or workflow changes.

Good first contribution areas

  • UI polish and layout fixes
  • timeline and agent-drawer UX improvements
  • repository safety and Git workflow hardening
  • docs improvements
  • test coverage for AppState and orchestration behavior

Development setup

git clone <repo-url>
cd CodexOpsStudio
swift build
swift run CodexOpsStudioApp

If you want in-app GitHub actions to work locally, make sure:

  • gh auth status succeeds
  • codex is installed and available in PATH

Contribution guidelines

  • Keep changes focused and reviewable.
  • Preserve the local-first and Git-safe product direction.
  • Do not add remote-publishing automation that bypasses explicit user confirmation.
  • Prefer small UI changes over broad visual rewrites unless discussed first.
  • Update CHANGELOG.md and VERSION when the change materially affects behavior.

Pull requests

Please include:

  • what changed
  • why it changed
  • how you tested it
  • screenshots or recordings for visible UI updates when possible

Reporting bugs

When filing a bug, include:

  • macOS version
  • how you installed Codex CLI
  • whether the target repository path contains non-ASCII characters
  • reproduction steps
  • logs or screenshots if available