openenv/pr_1041/en/_app/immutable/nodes/2.CPX2P_jb.js

import"../chunks/DsnmJJEf.js";import{i as S,h as U,C as M,H as t,a as J,E as B,s as _}from"../chunks/C07d6Hje.js";import{p as j,o as E,s as e,f as I,a as y,b as x,c as w,n as k}from"../chunks/BSuxAqoA.js";const P='{"title":"Contributing to OpenEnv","local":"contributing-to-openenv","sections":[{"title":"Ways to Contribute","local":"ways-to-contribute","sections":[{"title":"🐛 Report Bugs","local":"-report-bugs","sections":[],"depth":3},{"title":"💡 Suggest Features","local":"-suggest-features","sections":[],"depth":3},{"title":"🌍 Add an Environment","local":"-add-an-environment","sections":[],"depth":3},{"title":"☁️ Add a Runtime Provider","local":"-add-a-runtime-provider","sections":[],"depth":3},{"title":"📝 Improve Documentation","local":"-improve-documentation","sections":[],"depth":3},{"title":"🔧 Submit Code","local":"-submit-code","sections":[],"depth":3}],"depth":2},{"title":"Development Setup","local":"development-setup","sections":[],"depth":2},{"title":"Code Style","local":"code-style","sections":[],"depth":2},{"title":"Coordination","local":"coordination","sections":[],"depth":2},{"title":"License","local":"license","sections":[],"depth":2}],"depth":1}';var O=w('<meta name="hf:doc:metadata"/>'),W=w(`<p></p> <!> <!> <p>We welcome contributions from the community! OpenEnv is an open-source project and we’re excited to have you join us.</p> <!> <!> <p>Found a bug? Please <a href="https://github.com/huggingface/OpenEnv/issues/new" rel="nofollow">open an issue</a> with:</p> <ul><li>A clear description of the problem</li> <li>Steps to reproduce</li> <li>Expected vs actual behavior</li> <li>Your environment (Python version, OS, etc.)</li></ul> <!> <p>Have an idea? Open a <a href="https://github.com/huggingface/OpenEnv/issues/new" rel="nofollow">feature request</a> describing:</p> <ul><li>The problem you’re trying to solve</li> <li>Your proposed solution</li> <li>Any alternatives you’ve considered</li></ul> <!> <p>One of the best ways to contribute is to add a new environment! See the <a href="guides/first-environment">Building Environments</a> guide to get started.</p> <!> <p>To support a new runtime (a cloud sandbox, a scheduler, etc.), subclass <code>ContainerProvider</code> and follow the existing providers (<code>DaytonaProvider</code>, <code>ACASandboxProvider</code>) as references. To keep it consistent:</p> <ul><li>Put the SDK in a named <code>[project.optional-dependencies]</code> extra in <code>pyproject.toml</code> and import it lazily, so core OpenEnv stays SDK-free.</li> <li>Add an <code>[[autodoc]]</code> entry under “Container providers” in <code>docs/source/reference/core.md</code>.</li> <li>In the <a href="guides/runtime-providers">Runtime Providers guide</a>, add a row to the table and a “Per-provider setup” subsection (kept in alphabetical order).</li> <li>Add a test (the providers under <code>tests/test_core/</code> inject a fake SDK, so no network is needed).</li></ul> <p>See the Cloud Sandbox Providers amendment proposed in RFC 002 for the
provider-neutral invariants (direct base URL, WebSocket conformance, network posture).</p> <!> <p>Documentation improvements are always welcome:</p> <ul><li>Fix typos or unclear explanations</li> <li>Add examples</li> <li>Write tutorials</li> <li>Translate content</li></ul> <!> <ol><li>Fork the repository</li> <li>Create a feature branch: <code>git checkout -b feature/my-feature</code></li> <li>Make your changes</li> <li>Run tests: <code>pytest</code></li> <li>Submit a pull request</li></ol> <!> <!> <!> <ul><li>We use <a href="https://github.com/astral-sh/ruff" rel="nofollow">Ruff</a> for linting and formatting</li> <li>Write docstrings for public functions</li> <li>Add type hints</li> <li>Write tests for new functionality</li></ul> <!> <p>OpenEnv is openly governed by a technical committee that includes Meta-PyTorch, Reflection, Unsloth, Modal, Prime Intellect, Nvidia, Mercor, Fleet AI, Microsoft, Hugging Face, and RadixArk. The committee coordinates project direction, major technical decisions, RFCs, and release planning in public.</p> <p>Use the <a href="https://github.com/huggingface/OpenEnv" rel="nofollow">OpenEnv repository</a> to file
issues, discuss substantial changes, and submit pull requests.</p> <!> <p>By contributing, you agree that your contributions will be licensed under the same license as the project.</p> <p>Thank you for contributing! 🙏</p> <!> <p></p>`,1);function z(T,C){j(C,!1),E(()=>{new URLSearchParams(window.location.search).get("fw")}),S();var o=W();U("122tzrt",b=>{var f=O();_(f,"content",P),y(b,f)});var n=e(I(o),2);M(n,{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"});var i=e(n,2);t(i,{title:"Contributing to OpenEnv",local:"contributing-to-openenv",headingTag:"h1"});var a=e(i,4);t(a,{title:"Ways to Contribute",local:"ways-to-contribute",headingTag:"h2"});var l=e(a,2);t(l,{title:"🐛 Report Bugs",local:"-report-bugs",headingTag:"h3"});var s=e(l,6);t(s,{title:"💡 Suggest Features",local:"-suggest-features",headingTag:"h3"});var r=e(s,6);t(r,{title:"🌍 Add an Environment",local:"-add-an-environment",headingTag:"h3"});var d=e(r,4);t(d,{title:"☁️ Add a Runtime Provider",local:"-add-a-runtime-provider",headingTag:"h3"});var c=e(d,8);t(c,{title:"📝 Improve Documentation",local:"-improve-documentation",headingTag:"h3"});var p=e(c,6);t(p,{title:"🔧 Submit Code",local:"-submit-code",headingTag:"h3"});var u=e(p,4);t(u,{title:"Development Setup",local:"development-setup",headingTag:"h2"});var h=e(u,2);J(h,{code:"JTIzJTIwQ2xvbmUlMjB5b3VyJTIwZm9yayUwQWdpdCUyMGNsb25lJTIwaHR0cHMlM0ElMkYlMkZnaXRodWIuY29tJTJGWU9VUl9VU0VSTkFNRSUyRk9wZW5FbnYuZ2l0JTBBY2QlMjBPcGVuRW52JTBBJTBBJTIzJTIwSW5zdGFsbCUyMGluJTIwZGV2ZWxvcG1lbnQlMjBtb2RlJTBBcGlwJTIwaW5zdGFsbCUyMC1lJTIwJTIyLiU1QmRldiU1RCUyMiUwQSUwQSUyMyUyMFJ1biUyMHRlc3RzJTBBcHl0ZXN0JTBBJTBBJTIzJTIwUnVuJTIwbGludGluZyUwQXJ1ZmYlMjBjaGVjayUyMC4=",highlighted:`<span class="hljs-comment"># Clone your fork</span>
git <span class="hljs-built_in">clone</span> https://github.com/YOUR_USERNAME/OpenEnv.git
<span class="hljs-built_in">cd</span> OpenEnv

<span class="hljs-comment"># Install in development mode</span>
pip install -e <span class="hljs-string">&quot;.[dev]&quot;</span>

<span class="hljs-comment"># Run tests</span>
pytest

<span class="hljs-comment"># Run linting</span>
ruff check .`,lang:"bash",wrap:!1});var m=e(h,2);t(m,{title:"Code Style",local:"code-style",headingTag:"h2"});var g=e(m,4);t(g,{title:"Coordination",local:"coordination",headingTag:"h2"});var v=e(g,6);t(v,{title:"License",local:"license",headingTag:"h2"});var R=e(v,6);B(R,{source:"https://github.com/huggingface/openenv/blob/main/docs/source/contributing.md"}),k(2),y(T,o),x()}export{z as component};