<!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 @ main</title>
<meta name="description" content="CONTRIBUTING.md in fork/eza at main.">
<meta property="og:title" content="CONTRIBUTING.md - fork/eza @ main">
<meta property="og:description" content="CONTRIBUTING.md in fork/eza at main.">
<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="main" data-tip="8fbaca892254d78a1944b40b2dbc72ce18e6a27d">
<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">Tygo van den Hurk</span><span class="commit-message" data-commit="71c24c381036f32e24fbb41540e3e51a8aeb25e7">docs(typo): &quot;cheks&quot; should be &quot;checks&quot;</span><span class="snapshot-sha sha" data-commit="71c24c381036f32e24fbb41540e3e51a8aeb25e7">71c24c38</span><time datetime="2025-05-31T10:00:40+02:00" title="2025-05-31 10:00:40 +0200">2025-05-31</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/eza/ref/main/">main</a><strong>tags</strong><a 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>8.5 KiB</span><span>195 lines</span></span><span class="actions"><a class="raw" href="/fork/eza/raw/7c5c59159d591ccbed01ed992b4aa23f0c9adbd3/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">&lt;!--
SPDX-FileCopyrightText: 2023-2024 Christina Sørensen
SPDX-FileContributor: Christina Sørensen

SPDX-License-Identifier: EUPL-1.2
--&gt;
<h1>Contributing to eza</h1>
<p>If you'd like to contribute to eza, there are several things you should make
sure to familiarize yourself with first.</p>
<ul>
<li>Code of conduct <a href="/fork/eza/ref/main/blob/CODE_OF_CONDUCT.md">Contributor Covenant Code of Conduct</a></li>
<li>Requirement of conformance to <a href="https://www.conventionalcommits.org/en/v1.0.0/">Conventional Commits</a></li>
<li>Requirement of conformance to <a href="https://semver.org/">Semantic Versioning</a></li>
<li>The <a href="/fork/eza/ref/main/blob/SECURITY.md">Security Policy</a></li>
<li><a href="https://www.gnu.org/philosophy/free-sw.en.html">Free and Open Source (FOSS) software</a></li>
</ul>
<h2>Hacking on eza</h2>
<p>It is strongly recommended that you install Nix for hacking on eza. We leverage
nix  as a way to easily test and distribute eza to many users, and it allows us
to provide multiple tools easily for developers. Instead of having to install
each dependency manually and setting up a development environment, Nix allows
you  to use the same environment as the devs use.</p>
<p>Therefore, it is useful that you have a version of Nix installed with the
"experimental" feature flakes enabled. Further, to make hacking on eza as easy
as possible for yourself, you'd do yourself a favor to install
<a href="https://direnv.net/">direnv</a>.</p>
<p>When you enter the eza repository, if you have <code>direnv</code> installed, you'll be
prompted to allow it with <code>direnv allow</code>. Doing this will save you from having
to manually enter the development environment each time you open the folder. If
you don't have direnv installed however, you can run <code>nix develop</code> in a pinch,
to enter the direnv.</p>
<p>The development environment includes basic checks of conformance to conventional
commits, cargo clippy lints, and much more.</p>
<p>It also contains a pre-commit-hook making it a lot easier not to make potential
mistakes that will unnecessarily delay getting your PRs accepted. Most
importantly, it ensures your commits are conforming to conventional commits.</p>
<p>Some useful commands include:</p>
<ul>
<li><code>nix flake check</code>: checks everything is correct.</li>
<li><code>nix build</code>: build eza.</li>
<li><code>nix build .#test</code>: runs eza's cargo tests</li>
<li><code>nix build .#clippy</code>: runs clippy on eza</li>
<li><code>nix fmt</code>: automatically formats your code as required by flake checks and
pre-commit-hooks.nix</li>
<li><code>just itest</code>: runs integration tests</li>
</ul>
<p><strong>For non-nix users,</strong>
There are traditional <code>pre-commit</code> hooks, which you can install with your system package manager or
<code>brew|pip install pre-commit</code>, and run <code>pre-commit install -c .pre-commit-config-non-nix.yaml</code> in the root of the repository.
Then these hooks will run automatically when you commit.</p>
<p>The <a href="https://github.com/casey/just">just</a> command runner can be used to run some
helpful development commands, in a manner similar to <code>make</code>.  Run <code>just --list</code>
to get an overview of what’s available.</p>
<p>To compile the manual pages, you will need <a href="https://pandoc.org/">pandoc</a>, which
the nix flake should have installed for you.  The <code>just man</code> command will
compile the Markdown into manual pages, which it will place in the <code>target/man</code>
directory.</p>
<p>eza depends on <a href="https://github.com/rust-lang/git2-rs">libgit2</a> for certain
features.  If you’re unable to compile libgit2, you can opt out of Git support
by running <code>cargo build --no-default-features</code>. Again, the nix flake should
have taken care of this for you, if not, please file an issue.</p>
<p>If you intend to compile for musl, you will need to use the flag
<code>vendored-openssl</code> if you want to get the Git feature working.  The full command
is <code>cargo build --release --target=x86_64-unknown-linux-musl --features vendored-openssl,git</code>.</p>
<p>If you want more information on the tests please read:
<a href="https://github.com/eza-community/eza/blob/main/TESTING.md">testing on eza</a></p>
<h2>Creating a PR</h2>
<p>First, use the pull request template.</p>
<p>Please make sure that the thing you worked on... actually works. Make sure to
also add how you ensured this in the PR description. Further, it's expected
that you do your best to check for regressions.</p>
<p>If your PR introduces a flag, you MUST:</p>
<ul>
<li>Add completions for bash, zsh, fish, nushell</li>
<li>Add documentation to the man page</li>
<li>Add your option to the help flag</li>
<li>Add your option to the README.md</li>
</ul>
<p>Before submitting, you SHOULD have run <code>nix flake check</code> and ensured that all
issues are addressed. For formatting issues, <code>nix fmt</code> will format the code for
you. Most clippy issues can be resolved with <code>cargo clippy --fix</code> (although it
might be educational to fix them yourself). If you have reuse issues, you can
run the following command to annotate your code:</p>
<p>Here are the absolute basics:</p>
<ul>
<li>your commit summary MUST 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>
<p>Remember that no one here is an employee, and treat everyone with respect, as
the code of conduct specifies. Also remember to be patient if it takes a while
to get a response on your PR. Usually it doesn't, but there's only so many
hours in a day, and if possible, there would be no delay. The delay alone is
evidence of it's own necessity.</p>
<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 for a breaking change that follows these rules:</p>
<pre>fix(hyperlinks)!: TextCell building of detailed grid view, hyperlink, 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.

BREAKING CHANGE: The style codes for huge file and units where
documented to be `nt` and `ut` but the code was using `nh` and `uh`.
The code has been updated to match the documented style codes.
EXA_COLORS using style codes `nh` and `uh` will need to be updated to
use `nt` and `ut`.

Resolves: #129
Ref: #473, #319

Co-authored-by: 9glenda &lt;plan9git@proton.me&gt;
Signed-off-by: Christina Sørensen &lt;christina@cafkafk.com&gt;
</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>
</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-c>&lt;!--</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>SPDX-FileCopyrightText: 2023-2024 Christina Sørensen</a-p></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>SPDX-FileContributor: Christina Sørensen</a-p></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>SPDX-License-Identifier: EUPL-1.2</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>--&gt;</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"><a-p># </a-p><a-tt>Contributing to eza</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></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>If you&#39;d like to contribute to eza, there are several things you should make</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"><a-p>sure to familiarize yourself with first.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></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>- Code of conduct [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)</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>- Requirement of conformance to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)</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"><a-p>- Requirement of conformance to [Semantic Versioning](https://semver.org/)</a-p></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>- The [Security Policy](SECURITY.md)</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>- [Free and Open Source (FOSS) software](https://www.gnu.org/philosophy/free-sw.en.html)</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>## </a-p><a-tt>Hacking on eza</a-tt></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>It is strongly recommended that you install Nix for hacking on eza. We leverage</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>nix  as a way to easily test and distribute eza to many users, and it allows us</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>to provide multiple tools easily for developers. Instead of having to install</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>each dependency manually and setting up a development environment, Nix allows</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>you  to use the same environment as the devs use.</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"></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>Therefore, it is useful that you have a version of Nix installed with the</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>&quot;experimental&quot; feature flakes enabled. Further, to make hacking on eza as easy</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>as possible for yourself, you&#39;d do yourself a favor to install</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>[direnv](https://direnv.net/).</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"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>When you enter the eza repository, if you have `direnv` installed, you&#39;ll be</a-p></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>prompted to allow it with `direnv allow`. Doing this will save you from having</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>to manually enter the development environment each time you open the folder. If</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>you don&#39;t have direnv installed however, you can run `nix develop` in a pinch,</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>to enter the direnv.</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>The development environment includes basic checks of conformance to conventional</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>commits, cargo clippy lints, and much more.</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>It also contains a pre-commit-hook making it a lot easier not to make potential</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>mistakes that will unnecessarily delay getting your PRs accepted. Most</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"><a-p>importantly, it ensures your commits are conforming to conventional commits.</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"></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>Some useful commands include:</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>- `nix flake check`: checks everything is correct.</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"><a-p>- `nix build`: build eza.</a-p></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>- `nix build .#test`: runs eza&#39;s cargo tests</a-p></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>- `nix build .#clippy`: runs clippy on eza</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>- `nix fmt`: automatically formats your code as required by flake checks and</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>  pre-commit-hooks.nix</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>- `just itest`: runs integration tests</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>**For non-nix users,**</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>There are traditional `pre-commit` hooks, which you can install with your system package manager or</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>`brew|pip install pre-commit`, and run `pre-commit install -c .pre-commit-config-non-nix.yaml` in the root of the repository.</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>Then these hooks will run automatically when you commit.</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>The [just](https://github.com/casey/just) command runner can be used to run some</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>helpful development commands, in a manner similar to `make`.  Run `just --list`</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>to get an overview of what’s available.</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>To compile the manual pages, you will need [pandoc](https://pandoc.org/), which</a-p></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>the nix flake should have installed for you.  The `just man` command will</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>compile the Markdown into manual pages, which it will place in the `target/man`</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>directory.</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>eza depends on [libgit2](https://github.com/rust-lang/git2-rs) for certain</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"><a-p>features.  If you’re unable to compile libgit2, you can opt out of Git support</a-p></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>by running `cargo build --no-default-features`. Again, the nix flake should</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>have taken care of this for you, if not, please file an issue.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"></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>If you intend to compile for musl, you will need to use the flag</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>`vendored-openssl` if you want to get the Git feature working.  The full command</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>is `cargo build --release --target=x86_64-unknown-linux-musl --features</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>vendored-openssl,git`.</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"></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>If you want more information on the tests please read:</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>[testing on eza](https://github.com/eza-community/eza/blob/main/TESTING.md)</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"></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>## </a-p><a-tt>Creating a PR</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>First, use the pull request template.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>Please make sure that the thing you worked on... actually works. Make sure to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>also add how you ensured this in the PR description. Further, it&#39;s expected</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>that you do your best to check for regressions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>If your PR introduces a flag, you MUST:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>- Add completions for bash, zsh, fish, nushell</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>- Add documentation to the man page</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"><a-p>- Add your option to the help flag</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>- Add your option to the README.md</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>Before submitting, you SHOULD have run `nix flake check` and ensured that all</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>issues are addressed. For formatting issues, `nix fmt` will format the code for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>you. Most clippy issues can be resolved with `cargo clippy --fix` (although it</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>might be educational to fix them yourself). If you have reuse issues, you can</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>run the following command to annotate your code:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>Here are the absolute basics:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"><a-p>- your commit summary MUST follow conventional commits.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>- your commits SHOULD be separated into small, logical chunks.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>- reviewers may ask you to rebase your commits into more sensible chunks.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>- your PR will need to pass CI and local `cargo test`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>- you may be asked to refactor parts of your code by reviewers.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>Remember that no one here is an employee, and treat everyone with respect, as</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>the code of conduct specifies. Also remember to be patient if it takes a while</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>to get a response on your PR. Usually it doesn&#39;t, but there&#39;s only so many</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>hours in a day, and if possible, there would be no delay. The delay alone is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>evidence of it&#39;s own necessity.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</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="L114" href="#L114">114</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="L115" href="#L115">115</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="L116" href="#L116">116</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="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</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="L119" href="#L119">119</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="L120" href="#L120">120</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="L121" href="#L121">121</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="L122" href="#L122">122</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="L123" href="#L123">123</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="L124" href="#L124">124</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="L125" href="#L125">125</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="L126" href="#L126">126</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="L127" href="#L127">127</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="L128" href="#L128">128</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="L129" href="#L129">129</a><span class="code-text"><a-p>- ...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</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="L132" href="#L132">132</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="L133" href="#L133">133</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="L134" href="#L134">134</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</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="L136" href="#L136">136</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="L137" href="#L137">137</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="L138" href="#L138">138</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="L139" href="#L139">139</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="L140" href="#L140">140</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="L141" href="#L141">141</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</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="L143" href="#L143">143</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="L144" href="#L144">144</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="L145" href="#L145">145</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</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="L147" href="#L147">147</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="L148" href="#L148">148</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="L149" href="#L149">149</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</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="L151" href="#L151">151</a><span class="code-text"><a-p>Here is an example of a commit message for a breaking change that follows these rules:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>fix(hyperlinks)!: TextCell building of detailed grid view, hyperlink, icon options</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</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="L157" href="#L157">157</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="L158" href="#L158">158</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="L159" href="#L159">159</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="L160" href="#L160">160</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="L161" href="#L161">161</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>BREAKING CHANGE: The style codes for huge file and units where</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>documented to be `nt` and `ut` but the code was using `nh` and `uh`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-p>The code has been updated to match the documented style codes.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"><a-p>EXA_COLORS using style codes `nh` and `uh` will need to be updated to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>use `nt` and `ut`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</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="L169" href="#L169">169</a><span class="code-text"><a-p>Ref: #473, #319</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>Co-authored-by: 9glenda &lt;plan9git@proton.me&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"><a-p>Signed-off-by: Christina Sørensen &lt;christina@cafkafk.com&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</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="L176" href="#L176">176</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</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="L178" href="#L178">178</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="L179" href="#L179">179</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="L180" href="#L180">180</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="L181" href="#L181">181</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="L182" href="#L182">182</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</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="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</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="L186" href="#L186">186</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="L187" href="#L187">187</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="L188" href="#L188">188</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="L189" href="#L189">189</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="L190" href="#L190">190</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="L191" href="#L191">191</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="L192" href="#L192">192</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="L193" href="#L193">193</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="L194" href="#L194">194</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="L195" href="#L195">195</a><span class="code-text"><a-p>- </a-p>test: Adding missing tests or correcting existing tests</span></span></pre></div></div>
</main>
</body>
</html>
