1  import{_ as e,y as t,x as a,W as r}from"./plugin-vue_export-helper.f07d1dea.js";const m='{"title":"Contributing","description":"","frontmatter":{},"headers":[{"level":2,"title":"Making your changes","slug":"making-your-changes"},{"level":2,"title":"License","slug":"license"}],"relativePath":"contributing.md","lastUpdated":1692639959838}',n={},o=r(`<h1 id="contributing" tabindex="-1">Contributing <a class="header-anchor" href="#contributing" aria-hidden="true">#</a></h1><p>Thank you for your interest in contributing! There are many ways to contribute to <a href="https://github.com/blurgyy/dt" target="_blank" rel="noopener noreferrer"><code>dt</code></a>. You can start with examining unchecked items in the <a href="https://github.com/blurgyy/dt/blob/main/roadmap.md" target="_blank" rel="noopener noreferrer">roadmap</a>, or discuss some features to be added to the roadmap.</p><p>When contributing to this repository, please first discuss the change you wish to make via <a href="https://github.com/blurgyy/dt/issues" target="_blank" rel="noopener noreferrer">issue</a>, <a href="mailto:gy@blurgy.xyz">email</a>, or any other method with the owners of this repository before making a change.</p><p>Please note we have a <a href="https://github.com/blurgyy/dt/blob/main/CODE_OF_CONDUCT.md" target="_blank" rel="noopener noreferrer">code of conduct</a>, please follow it in all your interactions with the project.</p><h2 id="making-your-changes" tabindex="-1">Making your changes <a class="header-anchor" href="#making-your-changes" aria-hidden="true">#</a></h2><ol><li>Fork a copy of <code>dt</code> into your GitHub account and clone the forked repository to your development machine:<div class="language-shell"><pre><code>$ <span class="token function">git</span> clone https://github.com/<span class="token variable">\${your_account}</span>/dt.git <span class="token operator">&amp;&amp;</span> <span class="token builtin class-name">cd</span> dt
2  </code></pre></div></li><li>Install latest stable version of <a href="https://github.com/rust-lang/rust" target="_blank" rel="noopener noreferrer">Rust</a>, then make your commits. Please follow the <a href="https://www.conventionalcommits.org/" target="_blank" rel="noopener noreferrer">conventional commit specification</a> when writing your commit messages.</li><li>If features are added/updated, also add/update tests and documents and check if the tests are passed:<div class="language-shell"><pre><code>$ cargo <span class="token builtin class-name">test</span>
3  </code></pre></div></li><li>Resolve errors and warnings given by <code>cargo-clippy</code>:<div class="language-shell"><pre><code>$ cargo clippy
4  </code></pre></div></li><li>Format your changes with <code>cargo-fmt</code>:<div class="language-shell"><pre><code>$ cargo <span class="token function">fmt</span> -- --verbose
5  </code></pre></div></li><li>Submit a <a href="https://github.com/blurgyy/dt/pulls" target="_blank" rel="noopener noreferrer">pull request</a> and discuss the possible changes with the owner/maintainer, update your pull request if necessary.</li></ol><h2 id="license" tabindex="-1">License <a class="header-anchor" href="#license" aria-hidden="true">#</a></h2><p>By contributing, you agree that your contributions will be licenced under <a href="http://opensource.org/licenses/MIT" target="_blank" rel="noopener noreferrer">MIT</a> or <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank" rel="noopener noreferrer">Apache 2.0</a> license.</p>`,8),s=[o];function i(c,l,d,h,p,u){return a(),t("div",null,s)}var b=e(n,[["render",i]]);export{m as __pageData,b as default};