Deploying to gh-pages from @ cf8faf2 🚀

Author: Lee-W

contributing/contributing_tldr/index.html

@@ -1847,53 +1847,14 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#environment" class="md-nav__link">
+  <a href="#command-cheat-sheet" class="md-nav__link">
     <span class="md-ellipsis">
 
-        Environment
+        Command Cheat Sheet
 
     </span>
   </a>
 
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#useful-commands" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Useful commands
-      
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="Useful commands">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#code-changes" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Code Changes
-      
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#documentation-changes" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Documentation Changes
-      
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
 
     </ul>
@@ -2049,53 +2010,14 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#environment" class="md-nav__link">
+  <a href="#command-cheat-sheet" class="md-nav__link">
     <span class="md-ellipsis">
 
-        Environment
+        Command Cheat Sheet
 
     </span>
   </a>
 
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#useful-commands" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Useful commands
-      
-    </span>
-  </a>
-  
-    <nav class="md-nav" aria-label="Useful commands">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#code-changes" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Code Changes
-      
-    </span>
-  </a>
-  
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#documentation-changes" class="md-nav__link">
-    <span class="md-ellipsis">
-      
-        Documentation Changes
-      
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
 
     </ul>
@@ -2117,33 +2039,27 @@
 
 <h1 id="contributing-tldr">Contributing TL;DR<a class="headerlink" href="#contributing-tldr" title="Permanent link">&para;</a></h1>
 <p>Feel free to send a PR to update this file if you find anything useful. 🙇</p>
-<h2 id="environment">Environment<a class="headerlink" href="#environment" title="Permanent link">&para;</a></h2>
-<ul>
-<li>Python <code>&gt;=3.10</code></li>
-<li><a href="https://docs.astral.sh/uv/getting-started/installation/">uv</a> <code>&gt;=0.9.0</code></li>
-</ul>
-<h2 id="useful-commands">Useful commands<a class="headerlink" href="#useful-commands" title="Permanent link">&para;</a></h2>
-<p>Please check the <a href="https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml">pyproject.toml</a> for a comprehensive list of commands.</p>
-<h3 id="code-changes">Code Changes<a class="headerlink" href="#code-changes" title="Permanent link">&para;</a></h3>
-<div class="highlight"><pre><span></span><code><span class="c1"># Ensure you have the correct dependencies</span>
-uv<span class="w"> </span>sync<span class="w"> </span>--dev<span class="w"> </span>--frozen
-
-<span class="c1"># Make ruff happy</span>
+<p>For prerequisites and initial setup, see <a href="../contributing/#prerequisites-setup">Contributing to Commitizen</a>.</p>
+<h2 id="command-cheat-sheet">Command Cheat Sheet<a class="headerlink" href="#command-cheat-sheet" title="Permanent link">&para;</a></h2>
+<p>See <a href="https://github.com/commitizen-tools/commitizen/blob/master/pyproject.toml">pyproject.toml</a> for the full list of poe tasks.</p>
+<div class="highlight"><pre><span></span><code><span class="c1"># Format code (ruff check --fix + ruff format)</span>
 uv<span class="w"> </span>run<span class="w"> </span>poe<span class="w"> </span>format
 
-<span class="c1"># Check if ruff and mypy are happy</span>
+<span class="c1"># Lint (ruff check + mypy)</span>
 uv<span class="w"> </span>run<span class="w"> </span>poe<span class="w"> </span>lint
 
-<span class="c1"># Check if mypy is happy in python 3.10</span>
-mypy<span class="w"> </span>--python-version<span class="w"> </span><span class="m">3</span>.10
+<span class="c1"># Check mypy against a specific Python version</span>
+uv<span class="w"> </span>run<span class="w"> </span>mypy<span class="w"> </span>--python-version<span class="w"> </span><span class="m">3</span>.10
 
-<span class="c1"># Run tests in parallel.</span>
-pytest<span class="w"> </span>-n<span class="w"> </span>auto<span class="w"> </span><span class="c1"># This may take a while.</span>
-pytest<span class="w"> </span>-n<span class="w"> </span>auto<span class="w"> </span>&lt;test_suite&gt;
-</code></pre></div>
-<h3 id="documentation-changes">Documentation Changes<a class="headerlink" href="#documentation-changes" title="Permanent link">&para;</a></h3>
-<div class="highlight"><pre><span></span><code><span class="c1"># Build the documentation locally and check for broken links</span>
+<span class="c1"># Run tests in parallel (may take a while)</span>
+uv<span class="w"> </span>run<span class="w"> </span>pytest<span class="w"> </span>-n<span class="w"> </span>auto
+uv<span class="w"> </span>run<span class="w"> </span>pytest<span class="w"> </span>-n<span class="w"> </span>auto<span class="w"> </span>&lt;test_suite&gt;
+
+<span class="c1"># Build and preview docs locally</span>
 uv<span class="w"> </span>run<span class="w"> </span>poe<span class="w"> </span>doc
+
+<span class="c1"># Run everything (format + lint + check-commit + coverage)</span>
+uv<span class="w"> </span>run<span class="w"> </span>poe<span class="w"> </span>all
 </code></pre></div>
 
 
@@ -2165,7 +2081,7 @@ <h3 id="documentation-changes">Documentation Changes<a class="headerlink" href="
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="January 5, 2026 04:03:18 UTC">January 5, 2026</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="May 8, 2026 06:01:12 UTC">May 8, 2026</span>
   </span>