<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTING.md - fork/nix-minecraft @ develop</title>
<meta name="description" content="CONTRIBUTING.md in fork/nix-minecraft at develop.">
<meta property="og:title" content="CONTRIBUTING.md - fork/nix-minecraft @ develop">
<meta property="og:description" content="CONTRIBUTING.md in fork/nix-minecraft at develop.">
<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="develop" data-tip="2d96041674417ca3a55f7df3806ce3fc95b4f70a">
<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/nix-minecraft</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/nix-minecraft</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Infinidoge</span><span class="commit-message" data-commit="47c911107b4a1618cffc7bf5f42fcfff3924f0ac">meta: add CONTRIBUTING</span><span class="snapshot-sha sha" data-commit="47c911107b4a1618cffc7bf5f42fcfff3924f0ac">47c9111</span><time datetime="2023-10-28T01:32:55-04:00" title="2023-10-28 01:32:55 -0400">2023-10-28</time></p>
<header class="topbar"><details class="switcher"><summary>develop</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/nix-minecraft/ref/develop/">develop</a><a href="/fork/nix-minecraft/ref/feat/abduco/">feat/abduco</a><a href="/fork/nix-minecraft/ref/feat/legacy-fabric-servers/">feat/legacy-fabric-servers</a><a href="/fork/nix-minecraft/ref/lazymc/">lazymc</a><a href="/fork/nix-minecraft/ref/master/">master</a><a href="/fork/nix-minecraft/ref/module/fix-14/">module/fix-14</a><a class="all" href="/fork/nix-minecraft/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/nix-minecraft/">nix-minecraft</a> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>2.3 KiB</span><span>75 lines</span></span><span class="actions"><a class="raw" href="/fork/nix-minecraft/raw/bff2c6464c4cffe737495ab4fdb275af0800d783/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 Documentation</h1>
<h2>Commit Message Format</h2>
<pre>[scope]: [message]

[body]
</pre>
<p>There is no hard limit on commit message length, because the scope can make commit messages longer.</p>
<h3>Scope</h3>
<p>Scope is what the commit modifies.
Scopes should be all-lowercase, except when a part of the scope is explicitly not all lowercase (like <code>tools/fetchPackwizModpack</code>).</p>
<p>For packages, the scopes are:</p>
<ul>
<li><code>build-support</code> (Unless the change is primarily for one of the later scopes)</li>
<li><code>tools/{toolname}</code></li>
<li><code>vanilla-servers</code></li>
<li><code>fabric-servers</code></li>
<li><code>quilt-servers</code></li>
<li><code>legacy-fabric-servers</code></li>
<li><code>textile-servers</code> (Affects all of the 3 previous scopes)</li>
<li><code>paper-servers</code></li>
<li><code>velocity-servers</code></li>
</ul>
<p>For modules, the scopes are either:</p>
<ul>
<li><code>module</code> (Changes to the main <code>minecraft-servers</code> module)</li>
<li><code>modules/{modulename}</code> (Changes to modules that are either subparts of or separate from <code>minecraft-servers</code>)</li>
</ul>
<p>For tests, the scopes are:</p>
<ul>
<li><code>tests</code> (Changes to all tests)</li>
<li><code>tests/{testname}</code> (Changes to a specific test)</li>
</ul>
<p>Otherwise:</p>
<ul>
<li><code>flake</code> (Applies to either <code>flake.nix</code> or the flake as a whole)</li>
<li><code>meta</code> (Changes to documentation about the repository itself. Notably, the readme, todo, and contributing file. Changelog changes should be included in the commit that introduces the relevant change)</li>
<li><code>bump</code> (Bumps the version of something)</li>
</ul>
<h3>Message</h3>
<p>Do not capitalize the first letter of commit messages.
If you are adding in a new package, tool, test, etc, the message should be <code>init</code>.
Packages should have an update script called <code>update.py</code>, which hooks into the existing auto-update automation.
Otherwise, the message should be short, descriptive, and in the present tense.</p>
<h3>Body</h3>
<p>There are no particular rules for the body. If something deserves an explanation, then explain it in-depth here.</p>
<h2>Formatting</h2>
<p>All files should be formatted with <code>nixpkgs-fmt</code>.
This is linted by a PR check.</p>
<h2>Checks</h2>
<p>Please run <code>nix flake check</code> before submitting a PR.
This will run some basic package tests, as well as check formatting.</p>
<h2>Meta files</h2>
<h3>Changelog</h3>
<p>The changelog should be updated for any major and breaking changes to the repository. Namely, when things are deprecated and when things are removed.</p>
<h3>TODO</h3>
<p>Things that should get done in the future. If you feel like something needs work, feel free to include changes to TODO in your PR.</p>
</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 Documentation</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"><a-p>##</a-p> <a-tt>Commit Message Format</a-tt></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>```</a-p></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>[scope]: [message]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></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>[body]</a-p></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>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></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>There is no hard limit on commit message length, because the scope can make commit messages longer.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></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>### </a-p><a-tt>Scope</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></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>Scope is what the commit modifies.</a-p></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>Scopes should be all-lowercase, except when a part of the scope is explicitly not all lowercase (like `tools/fetchPackwizModpack`).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>For packages, the scopes are:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>- `build-support` (Unless the change is primarily for one of the later scopes)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>- `tools/{toolname}`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>- `vanilla-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>- `fabric-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>- `quilt-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>- `legacy-fabric-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>- `textile-servers` (Affects all of the 3 previous scopes)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>- `paper-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>- `velocity-servers`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>For modules, the scopes are either:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>- `module` (Changes to the main `minecraft-servers` module)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>- `modules/{modulename}` (Changes to modules that are either subparts of or separate from `minecraft-servers`)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>For tests, the scopes are:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>- `tests` (Changes to all tests)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>- `tests/{testname}` (Changes to a specific test)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>Otherwise:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>- `flake` (Applies to either `flake.nix` or the flake as a whole)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>- `meta` (Changes to documentation about the repository itself. Notably, the readme, todo, and contributing file. Changelog changes should be included in the commit that introduces the relevant change)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>- `bump` (Bumps the version of something)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>### </a-p><a-tt>Message</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>Do not capitalize the first letter of commit messages.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>If you are adding in a new package, tool, test, etc, the message should be `init`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>Packages should have an update script called `update.py`, which hooks into the existing auto-update automation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>Otherwise, the message should be short, descriptive, and in the present tense.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>### </a-p><a-tt>Body</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>There are no particular rules for the body. If something deserves an explanation, then explain it in-depth here.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>## </a-p><a-tt>Formatting</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>All files should be formatted with `nixpkgs-fmt`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>This is linted by a PR check.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>## </a-p><a-tt>Checks</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>Please run `nix flake check` before submitting a PR.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>This will run some basic package tests, as well as check formatting.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>## </a-p><a-tt>Meta files</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>### </a-p><a-tt>Changelog</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>The changelog should be updated for any major and breaking changes to the repository. Namely, when things are deprecated and when things are removed.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>### </a-p><a-tt>TODO</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text">Things that should get done in the future. If you feel like something needs work, feel free to include changes to TODO in your PR.</span></span></pre></div></div>
</main>
</body>
</html>
