import{A as e,d as t,m as n,t as r}from"./plugin-vue_export-helper-DazhzKqf.js";var i=JSON.parse(`{"path":"/guide/contributing.html","title":"Contributing","lang":"en-US","frontmatter":{},"git":{},"filePathRelative":"guide/contributing.md"}`),a={name:`contributing.md`};function o(r,i,a,o,s,c){return e(),t(`div`,null,[...i[0]||=[n(`<h1 id="contributing" tabindex="-1"><a class="header-anchor" href="#contributing"><span>Contributing</span></a></h1><p>First off, thanks for taking the time to contribute to HyperFlow!</p><h2 id="how-to-contribute" tabindex="-1"><a class="header-anchor" href="#how-to-contribute"><span>How to Contribute</span></a></h2><ol><li><strong>Reporting Bugs</strong>: Use GitHub Issues.</li><li><strong>Feature Requests</strong>: Check existing issues before opening a new one.</li><li><strong>Pull Requests</strong>: <ul><li>Fork the repo.</li><li>Create a new branch.</li><li>Ensure code passes lints (if applicable).</li><li>Submit the PR!</li></ul></li></ol><h2 id="environment-setup" tabindex="-1"><a class="header-anchor" href="#environment-setup"><span>Environment Setup</span></a></h2><p>To begin hacking on the local components (<code>GenerateLoopConfig</code>, the local DOMs and executors):</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line"><span class="token comment"># Clone the repository</span></span>
<span class="line"><span class="token function">git</span> clone https://github.com/lablnet/HyperFlow.git</span>
<span class="line"><span class="token builtin class-name">cd</span> HyperFlow</span>
<span class="line"></span>
<span class="line"><span class="token comment"># Create a virtual environment</span></span>
<span class="line">python3 <span class="token parameter variable">-m</span> venv .venv</span>
<span class="line"><span class="token builtin class-name">source</span> .venv/bin/activate</span>
<span class="line"></span>
<span class="line"><span class="token comment"># Install dependencies alongside dev additions</span></span>
<span class="line">pip <span class="token function">install</span> <span class="token parameter variable">-e</span> <span class="token string">".[dev]"</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="linting" tabindex="-1"><a class="header-anchor" href="#linting"><span>Linting</span></a></h2><p>We use <code>ruff</code> to maintain a very clean code base. Formatting must be identical to the internal styles. Run the linting targets manually before pushing code:</p><div class="language-bash line-numbers-mode" data-highlighter="prismjs" data-ext="sh"><pre><code class="language-bash"><span class="line">ruff check <span class="token builtin class-name">.</span></span>
<span class="line">ruff <span class="token function">format</span> <span class="token builtin class-name">.</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true" style="counter-reset:line-number 0;"><div class="line-number"></div><div class="line-number"></div></div></div>`,10)]])}var s=r(a,[[`render`,o]]);export{i as _pageData,s as default};
|
Download
