Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (51 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.13 KB

Contributing to Codex Unity Bridge

Welcome! We appreciate your interest in contributing to the Codex Unity Bridge. This guide will help you get started.

How to Contribute

  • Bug Reports: Open an issue with a clear description, steps to reproduce, and expected vs actual behavior
  • Feature Requests: Open an issue describing the use case and proposed solution
  • Pull Requests: Fork the repo, create a branch, make changes, and submit a PR
  • Questions: Open a discussion or issue for general questions

Development Setup

  1. Clone the repository

    git clone https://github.com/your-fork/codex-unity-bridge.git
cd codex-unity-bridge

  2. Install Python dependencies

    cd skill
pip install -e ".[dev]"

  3. Open Unity project (for testing Unity components)

    • Open the .TestProject folder in Unity 2021.3 or later

Testing Requirements

All contributions must pass existing tests. Before submitting a PR:

Python Skill Tests (CI)

cd skill
pytest tests/test_cli.py -v

These run automatically in CI on all PRs.

Unity Tests (Local Only)

Due to Unity's licensing constraints, C# tests must be run locally:

  1. Open the project in Unity 2021.3+
  2. Open Window > General > Test Runner
  3. Run all EditMode tests

Please confirm tests pass before submitting PRs that modify Editor/ or Tests/.

Code Style

  • Follow existing patterns and conventions in the codebase
  • Keep changes focused and minimal
  • No major refactors without prior discussion in an issue
  • Maintain the deterministic behavior of cli.py

PR Process

  1. Fork the repository
  2. Create a branch from main with a descriptive name (e.g., fix/timeout-handling, feat/new-command)
  3. Make your changes with clear, atomic commits
  4. Run all tests to ensure nothing is broken
  5. Submit a PR against main with a clear description of the changes

Code of Conduct

  • Be respectful and constructive in all interactions
  • Welcome newcomers and help them get started
  • Focus on the technical merits of contributions
  • Assume good intent from other contributors

Thank you for contributing!