Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (41 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1.55 KB

Contributing to codex-collab

Prerequisites

Development Setup

git clone https://github.com/Kevin7Qi/codex-collab.git
cd codex-collab
bun install
./install.sh --dev    # symlink for live iteration

On Windows (PowerShell):

powershell -ExecutionPolicy Bypass -File install.ps1 -Dev

Running Tests

bun test              # run all tests (integration tests are skipped by default)
bun run typecheck     # type checking

RUN_INTEGRATION=1 bun test   # include integration tests (requires codex CLI + credentials)

All tests must pass and type checking must be clean before submitting a PR.

Code of Conduct

This project follows the Contributor Covenant code of conduct.

Architecture

The codebase is organized into focused modules:

File Purpose
src/cli.ts CLI commands, argument parsing, output formatting
src/protocol.ts JSON-RPC client for Codex app server
src/threads.ts Thread lifecycle, short ID mapping
src/turns.ts Turn lifecycle, event wiring
src/events.ts Event dispatcher, log writer
src/approvals.ts Approval handler abstraction
src/types.ts Protocol types
src/config.ts Configuration constants

Pull Requests

  • Keep PRs focused — one feature or fix per PR
  • Run bun test and bun run typecheck before submitting
  • Write tests for new functionality
  • Follow existing code style and patterns