Contributing to Codexia

June 10, 2026 ยท View on GitHub

Thanks for your interest in improving Codexia! This guide explains how to set up your environment, make changes, and submit contributions.

Development Setup

Prerequisites:

Installation

Clone:

git clone https://github.com/milisp/codexia
cd codexia

Install dependencies:

bun install

Optional environment setup:

cp .env.example .env

Use this when you need to configure local environment variables for development or cloud-backed integrations.

Run the app in development:

bun tauri dev

Copy the pre-commit hook used in this repo to prevent common frontend issues.

cp docs/pre-commit .git/hooks/pre-commit

Build the frontend only:

# codex app-server generate-ts -o src/bindings  # Option to develop new codex feature
bun run build

Rust checks and formatting:

cd src-tauri && cargo check
# cd src-tauri && cargo fmt --all # Option format

Pull Request Process

  1. Fork the repository.
  2. Create a feature branch: git checkout -b feature/amazing-feature.
  3. Make changes with clear, English-only code comments and docs.
  4. Before pushing, verify builds pass:
    • bun run build
    • cd src-tauri && cargo check
  5. Push your branch: git push origin feature/amazing-feature.
  6. Open a Pull Request and describe your changes, rationale, and testing steps.

Reporting Bugs and Requesting Features

  • Use GitHub Issues for bug reports and feature requests.
  • Include steps to reproduce, expected vs. actual behavior, logs/screenshots, and environment details.

Style and Conventions

  • Language: English-only for code comments and documentation.
  • UI: shadcn UI components with Tailwind CSS.
  • State: Zustand with persistence.
  • Keep changes minimal, focused, and consistent with the existing codebase.

Learning Resources