Contributing to OpenEnv#

We welcome contributions from the community! OpenEnv is an open-source project and we’re excited to have you join us.

Ways to Contribute#

🐛 Report Bugs#

Found a bug? Please open an issue with:

  • A clear description of the problem

  • Steps to reproduce

  • Expected vs actual behavior

  • Your environment (Python version, OS, etc.)

💡 Suggest Features#

Have an idea? Open a feature request describing:

  • The problem you’re trying to solve

  • Your proposed solution

  • Any alternatives you’ve considered

🌍 Add an Environment#

One of the best ways to contribute is to add a new environment! See the Building Environments guide to get started.

📝 Improve Documentation#

Documentation improvements are always welcome:

  • Fix typos or unclear explanations

  • Add examples

  • Write tutorials

  • Translate content

🔧 Submit Code#

  1. Fork the repository

  2. Create a feature branch: git checkout -b feature/my-feature

  3. Make your changes

  4. Run tests: pytest

  5. Submit a pull request

Development Setup#

# Clone your fork
git clone https://github.com/YOUR_USERNAME/OpenEnv.git
cd OpenEnv

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Run linting
ruff check .

Code Style#

  • We use Ruff for linting and formatting

  • Write docstrings for public functions

  • Add type hints

  • Write tests for new functionality

Coordination#

OpenEnv is openly governed by a technical committee that includes Hugging Face, Unsloth, Reflection, and Meta PyTorch. The committee coordinates project direction, major technical decisions, RFCs, and release planning in public.

Use the OpenEnv repository to file issues, discuss substantial changes, and submit pull requests.

License#

By contributing, you agree that your contributions will be licensed under the same license as the project.

Thank you for contributing! 🙏

On this page