<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/CONTRIBUTING.md - fork/chhoto-url @ unicode</title>
<meta name="description" content="docs/CONTRIBUTING.md in fork/chhoto-url at unicode.">
<meta property="og:title" content="docs/CONTRIBUTING.md - fork/chhoto-url @ unicode">
<meta property="og:description" content="docs/CONTRIBUTING.md in fork/chhoto-url at unicode.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="unicode" data-tip="82d990341772a1a355f33bfc992a3e69d7ae0726">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/chhoto-url</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/chhoto-url</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">SinTan1729</span><span class="commit-message" data-commit="9e6cb8c0ca0bba2ce030834961dfa12c5a2636c9">docs: Added a CONTRIBUTING.md file</span><span class="snapshot-sha sha" data-commit="9e6cb8c0ca0bba2ce030834961dfa12c5a2636c9">9e6cb8c</span><time datetime="2026-06-28T17:11:37-05:00" title="2026-06-28 17:11:37 -0500">2026-06-28</time></p>
<header class="topbar"><details class="switcher"><summary>unicode</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/chhoto-url/ref/unicode/">unicode</a><a class="all" href="/fork/chhoto-url/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/chhoto-url/">chhoto-url</a> / <a href="/fork/chhoto-url/ref/unicode/tree/docs/">docs</a> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>17 lines</span></span><span class="actions"><a class="raw" href="/fork/chhoto-url/raw/9a65ee1fb594f33bb7a3a52b20425e8a7a3f848f/docs/CONTRIBUTING.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Contributing to Chhoto URL</h1>
<p>First of all, thanks for your interest in Chhoto URL. Any kind of contribution is welcome, as long as it adheres to the following rules.</p>
<ol>
<li>No AI contribution is allowed. I can't stop you from using AI privately, but I expect all submitted code to be written, reviewed, and
owned by the contributor. Do not list any AI tools as co-authors. You must take full responsibility for what you want to merge.</li>
<li>If it's a new feature, open a <a href="https://github.com/SinTan1729/chhoto-url/discussions">discussion</a> first. This helps avoid spending time
implementing features that aren't a good fit for the project.</li>
<li>Bug fixes do not require opening a discussion first unless they significantly change behavior.</li>
<li>When you open the PR, be very clear about what it does, and what problems it solves.</li>
<li>If you're making any changes to the backend, run <code>make test</code> to make sure that all the tests pass. For new features, you probably also
need to create new tests.</li>
<li>Please format your code with the standard formatters before you submit a PR e.g. <code>rustfmt</code> for Rust, and <code>prettier</code> for the frontend
stuff, and docs.</li>
<li>Everything must remain backwards compatible.</li>
<li>If you're making any changes to the frontend, be sure that it renders properly. Play around with it a bit, and add some screenshots in
the PR.</li>
</ol>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Contributing to Chhoto URL</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">First of all, thanks for your interest in Chhoto URL. Any kind of contribution is welcome, as long as it adheres to the following rules.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>1. </a-p>No AI contribution is allowed. I can&#39;t stop you from using AI privately, but I expect all submitted code to be written, reviewed, and</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>   </a-p>owned by the contributor. Do not list any AI tools as co-authors. You must take full responsibility for what you want to merge.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>1. </a-p>If it&#39;s a new feature, open a [discussion](https://github.com/SinTan1729/chhoto-url/discussions) first. This helps avoid spending time</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>   </a-p>implementing features that aren&#39;t a good fit for the project.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>1. </a-p>Bug fixes do not require opening a discussion first unless they significantly change behavior.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>1. </a-p>When you open the PR, be very clear about what it does, and what problems it solves.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>1. </a-p>If you&#39;re making any changes to the backend, run `make test` to make sure that all the tests pass. For new features, you probably also</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>   </a-p>need to create new tests.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>1. </a-p>Please format your code with the standard formatters before you submit a PR e.g. `rustfmt` for Rust, and `prettier` for the frontend</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>   </a-p>stuff, and docs.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>1. </a-p>Everything must remain backwards compatible.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>1. </a-p>If you&#39;re making any changes to the frontend, be sure that it renders properly. Play around with it a bit, and add some screenshots in</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>   </a-p>the PR.</span></span></pre></div></div>
</main>
</body>
</html>
