Buckets:

hf-doc-build/doc-dev / openenv /pr_749 /en /contributing.md
HuggingFaceDocBuilder's picture
|
download
raw
2.13 kB
# 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](https://github.com/huggingface/OpenEnv/issues/new) 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](https://github.com/huggingface/OpenEnv/issues/new) 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](guides/first-environment) 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
```bash
# 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](https://github.com/astral-sh/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](https://github.com/huggingface/OpenEnv) 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! ๐Ÿ™

Xet Storage Details

Size:
2.13 kB
ยท
Xet hash:
7ad4eda9b799d7f5bc99e052d1a255adb5e0fabcbfa7034f9490a6b9524f41cc

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.