<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>CONTRIBUTING.md - fork/eza @ v0.14.1</title>
<meta name="description" content="CONTRIBUTING.md in fork/eza at v0.14.1.">
<meta property="og:title" content="CONTRIBUTING.md - fork/eza @ v0.14.1">
<meta property="og:description" content="CONTRIBUTING.md in fork/eza at v0.14.1.">
<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="v0.14.1" data-tip="e32be28e737db5db596fb5c0c7405ce22f1544e4">
<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/eza</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/eza</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Christina Sørensen</span><span class="commit-message" data-commit="937709081039986f68372909c57aacf77ac25b13">Merge pull request #455 from dundargoc/docs/typos</span><span class="snapshot-sha sha" data-commit="937709081039986f68372909c57aacf77ac25b13">93770908</span><time datetime="2023-10-02T14:31:02+02:00" title="2023-10-02 14:31:02 +0200">2023-10-02</time></p>
<header class="topbar"><details class="switcher"><summary>v0.14.1</summary><div class="menu"><strong>branches</strong><a href="/fork/eza/ref/main/">main</a><strong>tags</strong><a class="current" href="/fork/eza/ref/v0.14.1/">v0.14.1</a><a href="/fork/eza/ref/v0.14.2/">v0.14.2</a><a href="/fork/eza/ref/v0.15.0/">v0.15.0</a><a href="/fork/eza/ref/v0.15.1/">v0.15.1</a><a href="/fork/eza/ref/v0.15.2/">v0.15.2</a><a href="/fork/eza/ref/v0.15.3/">v0.15.3</a><a href="/fork/eza/ref/v0.16.0/">v0.16.0</a><a href="/fork/eza/ref/v0.16.1/">v0.16.1</a><a class="all" href="/fork/eza/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/eza/">eza</a> / <span class="cur">CONTRIBUTING.md</span></nav>
<span class="view-stats"><span>3.4 KiB</span><span>85 lines</span></span><span class="actions"><a class="raw" href="/fork/eza/raw/cdaa390d01ed931444ed8f99bae47bf6e2a0b4ef/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</h1>
<p>If you wanna contribute to <code>eza</code>, here are the absolute basics:</p>
<ul>
<li>your commit summary should follow conventional commits.</li>
<li>your commits should be separated into small, logical chunks.</li>
<li>reviewers may ask you to rebase your commits into more sensible chunks.</li>
<li>your PR will need to pass CI and local <code>cargo test</code>.</li>
<li>you may be asked to refactor parts of your code by reviewers.</li>
</ul>
<h2>Commit Messages</h2>
<p>A common commit message contains at least a summary and reference with
closing action to the corresponding issue if any, and may also include a
description and signature.</p>
<h3>Summary</h3>
<p>For you commit messages, please use the first line for a brief summary what
the commit changes. Try to stay within the 72 char limit and prepend what type
of change. See the following list for some guidance:</p>
<ul>
<li>feat: adds a new feature to eza</li>
<li>feat(zsh): adds something to zsh completion</li>
<li>refactor: revises parts of the code</li>
<li>docs(readme): revise the README</li>
<li>docs(man): revision of the man pages</li>
<li>fix: bugfix in the code base</li>
<li>fix(ci): bugfix in the continuous integration</li>
<li>...</li>
</ul>
<p>Note that this list is not complete and there may be cases where a commit
could be characterized by different types, so just try to make your best
guess. This spares the maintainers a lot of work when merging your PR.</p>
<h3>Description</h3>
<p>If you commit warrants it due to complexity or external information required
to follow it, you should add a more detailed description of the changes,
reasoning and also link external documentation if necessary. This description
should go two lines below the summary and except for links stay in the 80 char
limit.</p>
<h3>Issue Reference</h3>
<p>If the commit resolves an issue add: <code>Resolves #abc</code> where <code>abc</code> is the issue
number. In case of a bugfix you can also use <code>Fixes #abc</code>.</p>
<h3>Signature</h3>
<p>You may add a signature at the end two lines below the description or
issue reference.</p>
<h3>Example</h3>
<p>Here is an example of a commit message that follows these rules (mostly):</p>
<pre>fix: TextCell building of detailed grid view for  hyperlink and icon options

The hyperlink option adds an escape sequence which in the normal TextCell
creation also becomes part of the length calculation. This patch applies
the same logic the normal grid already did, by using the filenames bare
width when a hyperlink is embedded. It also respects the ShowIcons
option just like the normal grid view.

Resolves #129
</pre>
<h3>Additional Examples</h3>
<ul>
<li>feat: add column selection</li>
<li>fix(output): fix width issue with columns</li>
<li>test(fs): add tests for filesystem metadata</li>
<li>feat!: breaking change / feat(config)!: implement config file</li>
<li>chore(deps): update dependencies</li>
</ul>
<h3>Commit types</h3>
<ul>
<li>build: Changes that affect the build system or external dependencies (example libgit2)</li>
<li>ci: Changes to CI configuration files and scripts (example scopes: Nix, Vagrant, Docker)</li>
<li>chore: Changes which do not change source code or tests (example: changes to the build process, auxiliary tools, libraries)</li>
<li>docs: Documentation, README, completions, manpage only</li>
<li>feat: A new feature</li>
<li>fix: A bug fix</li>
<li>perf: A code change that improves or addresses a performance issue</li>
<li>refactor: A code change that neither fixes a bug nor adds a feature</li>
<li>revert: Revert something</li>
<li>style: Changes that do not affect the meaning of the code (example: clippy)</li>
<li>test: Adding missing tests or correcting existing tests</li>
</ul>
<h3>Reminders</h3>
<p>Put newline before extended commit body
More details at conventionalcommits.org</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</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">If you wanna contribute to `eza`, here are the absolute basics:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>- </a-p>your commit summary should follow conventional commits.</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>your commits should be separated into small, logical chunks.</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>reviewers may ask you to rebase your commits into more sensible chunks.</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>- </a-p>your PR will need to pass CI and local `cargo test`.</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>you may be asked to refactor parts of your code by reviewers.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></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>## </a-p><a-tt>Commit Messages</a-tt></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>A common commit message contains at least a summary and reference with</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"><a-p>closing action to the corresponding issue if any, and may also include a</a-p></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>description and signature.</a-p></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>### </a-p><a-tt>Summary</a-tt></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>For you commit messages, please use the first line for a brief summary what</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"><a-p>the commit changes. Try to stay within the 72 char limit and prepend what type</a-p></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>of change. See the following list for some guidance:</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"><a-p>- feat: adds a new feature to eza</a-p></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>- feat(zsh): adds something to zsh completion</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>- refactor: revises parts of the code</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>- docs(readme): revise the README</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>- docs(man): revision of the man pages</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>- fix: bugfix in the code base</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>- fix(ci): bugfix in the continuous integration</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>- ...</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"></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>Note that this list is not complete and there may be cases where a commit</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"><a-p>could be characterized by different types, so just try to make your best</a-p></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>guess. This spares the maintainers a lot of work when merging your PR.</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>### </a-p><a-tt>Description</a-tt></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>If you commit warrants it due to complexity or external information required</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"><a-p>to follow it, you should add a more detailed description of the changes,</a-p></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>reasoning and also link external documentation if necessary. This description</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"><a-p>should go two lines below the summary and except for links stay in the 80 char</a-p></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>limit.</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>### </a-p><a-tt>Issue Reference</a-tt></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>If the commit resolves an issue add: `Resolves #abc` where `abc` is the issue</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"><a-p>number. In case of a bugfix you can also use `Fixes #abc`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></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>### </a-p><a-tt>Signature</a-tt></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>You may add a signature at the end two lines below the description or</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"><a-p>issue reference.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>### </a-p><a-tt>Example</a-tt></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>Here is an example of a commit message that follows these rules (mostly):</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>```</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>fix: TextCell building of detailed grid view for  hyperlink and icon options</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>The hyperlink option adds an escape sequence which in the normal TextCell</a-p></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>creation also becomes part of the length calculation. This patch applies</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>the same logic the normal grid already did, by using the filenames bare</a-p></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>width when a hyperlink is embedded. It also respects the ShowIcons</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"><a-p>option just like the normal grid view.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>Resolves #129</a-p></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>```</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>### </a-p><a-tt>Additional Examples</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>- feat: add column selection</a-p></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>- fix(output): fix width issue with columns</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>- test(fs): add tests for filesystem metadata</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"><a-p>- feat!: breaking change / feat(config)!: implement config file</a-p></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>- chore(deps): update dependencies</a-p></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>Commit types</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>- build: Changes that affect the build system or external dependencies (example libgit2)</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"><a-p>- ci: Changes to CI configuration files and scripts (example scopes: Nix, Vagrant, Docker)</a-p></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>- chore: Changes which do not change source code or tests (example: changes to the build process, auxiliary tools, libraries)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>- docs: Documentation, README, completions, manpage only</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>- feat: A new feature</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>- fix: A bug fix</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>- perf: A code change that improves or addresses a performance issue</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>- refactor: A code change that neither fixes a bug nor adds a feature</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>- revert: Revert something</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>- style: Changes that do not affect the meaning of the code (example: clippy)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"><a-p>- test: Adding missing tests or correcting existing tests</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"><a-p>### </a-p><a-tt>Reminders</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text">Put newline before extended commit body</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text">More details at conventionalcommits.org</span></span></pre></div></div>
</main>
</body>
</html>
