Deployed 21c06b7 with MkDocs version: 1.5.3

contributing/index.html

@@ -5,6 +5,7 @@
 <span class=go>pre-commit installed at .git/hooks/pre-commit</span>
 </code></pre></div><p>This will ensure that all code meets the required linting standard before being committed.</p><h3 id=run-pre-commit-manually>Run pre-commit manually</h3><p>You can run these checks manually on all staged files using the below command :</p><div class=highlight><pre><span></span><code><span class=go>poe pre</span>
 </code></pre></div><h2 id=testing>Testing</h2><p>We are using <a href=https://docs.pytest.org/ >pytest</a> for testing.</p><p>At the moment the test framework is set up but we only have about 50% coverage. We will be adding more tests as we go along - and most definitely welcome any contributions to this area!</p><p>If you add any new features, please add tests for them. This will help us to ensure that the code is working as expected and will prevent any regressions. <em>Currently we are not enforcing this until we have better coverage of the code - <strong>however if you break any existing tests, the CI will fail.</strong></em></p><p>There is a task set up to run tests:</p><div class=highlight><pre><span></span><code><span class=gp>$ </span>poe<span class=w> </span><span class=nb>test</span>
+</code></pre></div><p>And run a watcher to automatically re-run the tests when files change:</p><div class=highlight><pre><span></span><code><span class=gp>$ </span>poe<span class=w> </span>test:watch
 </code></pre></div><p>You can also run the tests manually using the following command:</p><div class=highlight><pre><span></span><code><span class=gp>$ </span>pytest
 </code></pre></div><p>The task is set up so we can automatically add other options in the future.</p><h2 id=changelog>Changelog</h2><p>The changelog is automatically generated, using this project, so please do not edit it manually.</p><p>For maintainers, there is a POE task that will run this and update the changelog file.</p><div class=highlight><pre><span></span><code><span class=gp>$ </span>poe<span class=w> </span>changelog
 </code></pre></div><p>You would also need to add a GitHub Personal Access Token to a local config file as usual. See the section in the <a href=https://changelog.seapagan.net/installation/#setup-a-github-pat>Documentation</a> for information.</p><p><strong>However, you should NOT include a change to the <code>CHANGELOG.md</code> file in any Pull Requests. This will be handled by the maintainers when a new release is made</strong>. Your GitHub username will be added to the changelog automatically beside your PR.</p><h2 id=convenience-tasks>Convenience Tasks</h2><p>There are a few other convenience tasks that can be run using the <code>poe</code> command. These are defined in the <code>pyproject.toml</code> file.</p><p>Each of these tasks can have extra options added which will be passed to the underlying tool.</p><p>Run <strong><code>mypy</code></strong> on the code base in strict mode:</p><div class=highlight><pre><span></span><code><span class=gp>$ </span>poe<span class=w> </span>mypy

sitemap.xml

@@ -2,62 +2,62 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://pymaker.seapagan.net/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/changelog/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/configuration/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/contributing/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/future-plans/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/installation/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/license/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/tasks/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/usage/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/template/internal/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/template/modify/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
     <url>
          <loc>https://pymaker.seapagan.net/template/replace/</loc>
-         <lastmod>2024-03-12</lastmod>
+         <lastmod>2024-03-13</lastmod>
          <changefreq>daily</changefreq>
     </url>
 </urlset>