build based on 703684d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-21T19:50:46","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-21T22:47:50","documenter_version":"1.7.0"}}

dev/91-developer/index.html

@@ -7,4 +7,4 @@
 pkg&gt; test</code></pre><h2 id="Working-on-a-new-issue"><a class="docs-heading-anchor" href="#Working-on-a-new-issue">Working on a new issue</a><a id="Working-on-a-new-issue-1"></a><a class="docs-heading-anchor-permalink" href="#Working-on-a-new-issue" title="Permalink"></a></h2><p>We try to keep a linear history in this repo, so it is important to keep your branches up-to-date.</p><ol><li><p>Fetch from the remote and fast-forward your local main</p><pre><code class="language-bash hljs">git fetch upstream
 git switch main
 git merge --ff-only upstream/main</code></pre></li><li><p>Branch from <code>main</code> to address the issue (see below for naming)</p><pre><code class="language-bash hljs">git switch -c 42-add-answer-universe</code></pre></li><li><p>Push the new local branch to your personal remote repository</p><pre><code class="language-bash hljs">git push -u origin 42-add-answer-universe</code></pre></li><li><p>Create a pull request to merge your remote branch into the org main.</p></li></ol><h3 id="Branch-naming"><a class="docs-heading-anchor" href="#Branch-naming">Branch naming</a><a id="Branch-naming-1"></a><a class="docs-heading-anchor-permalink" href="#Branch-naming" title="Permalink"></a></h3><ul><li>If there is an associated issue, add the issue number.</li><li>If there is no associated issue, <strong>and the changes are small</strong>, add a prefix such as &quot;typo&quot;, &quot;hotfix&quot;, &quot;small-refactor&quot;, according to the type of update.</li><li>If the changes are not small and there is no associated issue, then create the issue first, so we can properly discuss the changes.</li><li>Use dash separated imperative wording related to the issue (e.g., <code>14-add-tests</code>, <code>15-fix-model</code>, <code>16-remove-obsolete-files</code>).</li></ul><h3 id="Commit-message"><a class="docs-heading-anchor" href="#Commit-message">Commit message</a><a id="Commit-message-1"></a><a class="docs-heading-anchor-permalink" href="#Commit-message" title="Permalink"></a></h3><ul><li>Use imperative or present tense, for instance: <em>Add feature</em> or <em>Fix bug</em>.</li><li>Have informative titles.</li><li>When necessary, add a body with details.</li><li>If there are breaking changes, add the information to the commit message.</li></ul><h3 id="Before-creating-a-pull-request"><a class="docs-heading-anchor" href="#Before-creating-a-pull-request">Before creating a pull request</a><a id="Before-creating-a-pull-request-1"></a><a class="docs-heading-anchor-permalink" href="#Before-creating-a-pull-request" title="Permalink"></a></h3><div class="admonition is-success"><header class="admonition-header">Atomic git commits</header><div class="admonition-body"><p>Try to create &quot;atomic git commits&quot; (recommended reading: <a href="https://blog.esciencecenter.nl/the-utopic-git-history-d44b81c09593">The Utopic Git History</a>).</p></div></div><ul><li><p>Make sure the tests pass.</p></li><li><p>Make sure the pre-commit tests pass.</p></li><li><p>Fetch any <code>main</code> updates from upstream and rebase your branch, if necessary:</p><pre><code class="language-bash hljs">git fetch upstream
-git rebase upstream/main BRANCH_NAME</code></pre></li><li><p>Then you can open a pull request and work with the reviewer to address any issues.</p></li></ul><h2 id="Building-and-viewing-the-documentation-locally"><a class="docs-heading-anchor" href="#Building-and-viewing-the-documentation-locally">Building and viewing the documentation locally</a><a id="Building-and-viewing-the-documentation-locally-1"></a><a class="docs-heading-anchor-permalink" href="#Building-and-viewing-the-documentation-locally" title="Permalink"></a></h2><p>To build the documentation locally, simply run</p><pre><code class="language-bash hljs">julia docs/liveserver.jl</code></pre><p>This will build the documentation and open a preview in your browser. Whenever you make some changes in the documentation files, the preview will also update live.</p><h2 id="Making-a-new-release"><a class="docs-heading-anchor" href="#Making-a-new-release">Making a new release</a><a id="Making-a-new-release-1"></a><a class="docs-heading-anchor-permalink" href="#Making-a-new-release" title="Permalink"></a></h2><p>To create a new release, you can follow these simple steps:</p><ul><li>Create a branch <code>release-x.y.z</code></li><li>Update <code>version</code> in <code>Project.toml</code></li><li>Update the <code>CHANGELOG.md</code>:<ul><li>Rename the section &quot;Unreleased&quot; to &quot;[x.y.z] - yyyy-mm-dd&quot; (i.e., version under brackets, dash, and date in ISO format)</li><li>Add a new section on top of it named &quot;Unreleased&quot;</li><li>Add a new link in the bottom for version &quot;x.y.z&quot;</li><li>Change the &quot;[unreleased]&quot; link to use the latest version - end of line, <code>vx.y.z ... HEAD</code>.</li></ul></li><li>Create a commit &quot;Release vx.y.z&quot;, push, create a PR, wait for it to pass, merge the PR.</li><li>Go back to main screen and click on the latest commit (link: <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/commit/main">https://github.com/lucaferranti/DedekindCutArithmetic.jl/commit/main</a>)</li><li>At the bottom, write <code>@JuliaRegistrator register</code></li></ul><p>After that, you only need to wait and verify:</p><ul><li>Wait for the bot to comment (should take &lt; 1m) with a link to a PR to the registry</li><li>Follow the link and wait for a comment on the auto-merge</li><li>The comment should said all is well and auto-merge should occur shortly</li><li>After the merge happens, TagBot will trigger and create a new GitHub tag. Check on <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/releases">https://github.com/lucaferranti/DedekindCutArithmetic.jl/releases</a></li><li>After the release is create, a &quot;docs&quot; GitHub action will start for the tag.</li><li>After it passes, a deploy action will run.</li><li>After that runs, the <a href="https://lucaferranti.github.io/DedekindCutArithmetic.jl/stable">stable docs</a> should be updated. Check them and look for the version number.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../90-contributing/">« Contributor&#39;s guide</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 19:50">Monday 21 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+git rebase upstream/main BRANCH_NAME</code></pre></li><li><p>Then you can open a pull request and work with the reviewer to address any issues.</p></li></ul><h2 id="Building-and-viewing-the-documentation-locally"><a class="docs-heading-anchor" href="#Building-and-viewing-the-documentation-locally">Building and viewing the documentation locally</a><a id="Building-and-viewing-the-documentation-locally-1"></a><a class="docs-heading-anchor-permalink" href="#Building-and-viewing-the-documentation-locally" title="Permalink"></a></h2><p>To build the documentation locally, simply run</p><pre><code class="language-bash hljs">julia docs/liveserver.jl</code></pre><p>This will build the documentation and open a preview in your browser. Whenever you make some changes in the documentation files, the preview will also update live.</p><h2 id="Making-a-new-release"><a class="docs-heading-anchor" href="#Making-a-new-release">Making a new release</a><a id="Making-a-new-release-1"></a><a class="docs-heading-anchor-permalink" href="#Making-a-new-release" title="Permalink"></a></h2><p>To create a new release, you can follow these simple steps:</p><ul><li>Create a branch <code>release-x.y.z</code></li><li>Update <code>version</code> in <code>Project.toml</code></li><li>Update the <code>CHANGELOG.md</code>:<ul><li>Rename the section &quot;Unreleased&quot; to &quot;[x.y.z] - yyyy-mm-dd&quot; (i.e., version under brackets, dash, and date in ISO format)</li><li>Add a new section on top of it named &quot;Unreleased&quot;</li><li>Add a new link in the bottom for version &quot;x.y.z&quot;</li><li>Change the &quot;[unreleased]&quot; link to use the latest version - end of line, <code>vx.y.z ... HEAD</code>.</li></ul></li><li>Create a commit &quot;Release vx.y.z&quot;, push, create a PR, wait for it to pass, merge the PR.</li><li>Go back to main screen and click on the latest commit (link: <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/commit/main">https://github.com/lucaferranti/DedekindCutArithmetic.jl/commit/main</a>)</li><li>At the bottom, write <code>@JuliaRegistrator register</code></li></ul><p>After that, you only need to wait and verify:</p><ul><li>Wait for the bot to comment (should take &lt; 1m) with a link to a PR to the registry</li><li>Follow the link and wait for a comment on the auto-merge</li><li>The comment should said all is well and auto-merge should occur shortly</li><li>After the merge happens, TagBot will trigger and create a new GitHub tag. Check on <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/releases">https://github.com/lucaferranti/DedekindCutArithmetic.jl/releases</a></li><li>After the release is create, a &quot;docs&quot; GitHub action will start for the tag.</li><li>After it passes, a deploy action will run.</li><li>After that runs, the <a href="https://lucaferranti.github.io/DedekindCutArithmetic.jl/stable">stable docs</a> should be updated. Check them and look for the version number.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../90-contributing/">« Contributor&#39;s guide</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 22:47">Monday 21 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>