mirror of
https://github.com/xlorepdarkhelm/numinar-coding-project.git
synced 2026-09-09 17:45:35 -04:00
818 lines
30 KiB
HTML
818 lines
30 KiB
HTML
<!DOCTYPE html>
|
|
<html class="no-js" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
<meta name="color-scheme" content="light dark" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link
|
|
rel="next"
|
|
title="Contributor Covenant Code of Conduct"
|
|
href="codeofconduct.html"
|
|
/>
|
|
<link rel="prev" title="Reference" href="reference.html" />
|
|
|
|
<!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
|
|
<title>Contributor Guide - Backend documentation</title>
|
|
<link
|
|
rel="stylesheet"
|
|
type="text/css"
|
|
href="_static/pygments.css?v=d111a655"
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
type="text/css"
|
|
href="_static/styles/furo.css?v=580074bf"
|
|
/>
|
|
<link
|
|
rel="stylesheet"
|
|
type="text/css"
|
|
href="_static/styles/furo-extensions.css?v=8dab3a3b"
|
|
/>
|
|
|
|
<style>
|
|
body {
|
|
--color-code-background: #f2f2f2;
|
|
--color-code-foreground: #1e1e1e;
|
|
}
|
|
@media not print {
|
|
body[data-theme="dark"] {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
}
|
|
@media (prefers-color-scheme: dark) {
|
|
body:not([data-theme="light"]) {
|
|
--color-code-background: #202020;
|
|
--color-code-foreground: #d0d0d0;
|
|
}
|
|
}
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<script>
|
|
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
</script>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none">
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
<title>Contents</title>
|
|
<svg
|
|
stroke="currentColor"
|
|
fill="currentColor"
|
|
stroke-width="0"
|
|
viewBox="0 0 1024 1024"
|
|
>
|
|
<path
|
|
d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"
|
|
/>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
<title>Menu</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="2"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="feather-menu"
|
|
>
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
<title>Expand</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="2"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="feather-chevron-right"
|
|
>
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
<title>Light mode</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="feather-sun"
|
|
>
|
|
<circle cx="12" cy="12" r="5"></circle>
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
<title>Dark mode</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="icon-tabler-moon"
|
|
>
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
<path
|
|
d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z"
|
|
/>
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
|
|
<title>Auto light/dark, in light mode</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="icon-custom-derived-from-feather-sun-and-tabler-moon"
|
|
>
|
|
<path
|
|
style="opacity: 50%"
|
|
d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"
|
|
/>
|
|
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25" />
|
|
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85" />
|
|
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68" />
|
|
<line x1="19" y1="14.05" x2="20.414" y2="15.464" />
|
|
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55" />
|
|
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55" />
|
|
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42" />
|
|
<line x1="19" y1="5.05" x2="20.414" y2="3.636" />
|
|
<circle cx="14.5" cy="9.55" r="3.6" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
|
|
<title>Auto light/dark, in dark mode</title>
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="icon-custom-derived-from-feather-sun-and-tabler-moon"
|
|
>
|
|
<path
|
|
d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"
|
|
/>
|
|
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5" />
|
|
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5" />
|
|
<line
|
|
style="opacity: 50%"
|
|
x1="15.316"
|
|
y1="4.816"
|
|
x2="14.464"
|
|
y2="3.964"
|
|
/>
|
|
<line
|
|
style="opacity: 50%"
|
|
x1="20.711"
|
|
y1="10.212"
|
|
x2="21.563"
|
|
y2="11.063"
|
|
/>
|
|
<line
|
|
style="opacity: 50%"
|
|
x1="14.205"
|
|
y1="7.5"
|
|
x2="13.001"
|
|
y2="7.5"
|
|
/>
|
|
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5" />
|
|
<line
|
|
style="opacity: 50%"
|
|
x1="15.316"
|
|
y1="10.184"
|
|
x2="14.464"
|
|
y2="11.036"
|
|
/>
|
|
<line
|
|
style="opacity: 50%"
|
|
x1="20.711"
|
|
y1="4.789"
|
|
x2="21.563"
|
|
y2="3.937"
|
|
/>
|
|
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-pencil" viewBox="0 0 24 24">
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="icon-tabler-pencil-code"
|
|
>
|
|
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
|
|
<path d="M13.5 6.5l4 4" />
|
|
<path d="M20 21l2 -2l-2 -2" />
|
|
<path d="M17 17l-2 2l2 2" />
|
|
</svg>
|
|
</symbol>
|
|
<symbol id="svg-eye" viewBox="0 0 24 24">
|
|
<svg
|
|
xmlns="http://www.w3.org/2000/svg"
|
|
viewBox="0 0 24 24"
|
|
fill="none"
|
|
stroke="currentColor"
|
|
stroke-width="1"
|
|
stroke-linecap="round"
|
|
stroke-linejoin="round"
|
|
class="icon-tabler-eye-code"
|
|
>
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
|
|
<path
|
|
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008"
|
|
/>
|
|
<path d="M20 21l2 -2l-2 -2" />
|
|
<path d="M17 17l-2 2l2 2" />
|
|
</svg>
|
|
</symbol>
|
|
</svg>
|
|
|
|
<input
|
|
type="checkbox"
|
|
class="sidebar-toggle"
|
|
name="__navigation"
|
|
id="__navigation"
|
|
aria-label="Toggle site navigation sidebar"
|
|
/>
|
|
<input
|
|
type="checkbox"
|
|
class="sidebar-toggle"
|
|
name="__toc"
|
|
id="__toc"
|
|
aria-label="Toggle table of contents sidebar"
|
|
/>
|
|
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
|
<label class="overlay toc-overlay" for="__toc"></label>
|
|
|
|
<a class="skip-to-content muted-link" href="#furo-main-content"
|
|
>Skip to content</a
|
|
>
|
|
|
|
<div class="page">
|
|
<header class="mobile-header">
|
|
<div class="header-left">
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
<span class="icon"
|
|
><svg><use href="#svg-menu"></use></svg
|
|
></span>
|
|
</label>
|
|
</div>
|
|
<div class="header-center">
|
|
<a href="index.html"
|
|
><div class="brand">Backend documentation</div></a
|
|
>
|
|
</div>
|
|
<div class="header-right">
|
|
<div class="theme-toggle-container theme-toggle-header">
|
|
<button
|
|
class="theme-toggle"
|
|
aria-label="Toggle Light / Dark / Auto color theme"
|
|
>
|
|
<svg class="theme-icon-when-auto-light">
|
|
<use href="#svg-sun-with-moon"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-auto-dark">
|
|
<use href="#svg-moon-with-sun"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-dark">
|
|
<use href="#svg-moon"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-light">
|
|
<use href="#svg-sun"></use>
|
|
</svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
<span class="icon"
|
|
><svg><use href="#svg-toc"></use></svg
|
|
></span>
|
|
</label>
|
|
</div>
|
|
</header>
|
|
<aside class="sidebar-drawer">
|
|
<div class="sidebar-container">
|
|
<div class="sidebar-sticky">
|
|
<a class="sidebar-brand" href="index.html">
|
|
<span class="sidebar-brand-text">Backend documentation</span>
|
|
</a>
|
|
<form
|
|
class="sidebar-search-container"
|
|
method="get"
|
|
action="search.html"
|
|
role="search"
|
|
>
|
|
<input
|
|
class="sidebar-search"
|
|
placeholder="Search"
|
|
name="q"
|
|
aria-label="Search"
|
|
/>
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<div id="searchbox"></div>
|
|
<div class="sidebar-scroll">
|
|
<div class="sidebar-tree">
|
|
<ul class="current">
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="usage.html">Usage</a>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="reference.html"
|
|
>Reference</a
|
|
>
|
|
</li>
|
|
<li class="toctree-l1 current current-page">
|
|
<a class="current reference internal" href="#"
|
|
>Contributor Guide</a
|
|
>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="codeofconduct.html"
|
|
>Code of Conduct</a
|
|
>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a class="reference internal" href="license.html"
|
|
>License</a
|
|
>
|
|
</li>
|
|
<li class="toctree-l1">
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend/releases"
|
|
>Changelog</a
|
|
>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
<div class="main">
|
|
<div class="content">
|
|
<div class="article-container">
|
|
<a href="#" class="back-to-top muted-link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
<path
|
|
d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"
|
|
></path>
|
|
</svg>
|
|
<span>Back to top</span>
|
|
</a>
|
|
<div class="content-icon-container">
|
|
<div class="view-this-page">
|
|
<a
|
|
class="muted-link"
|
|
href="_sources/contributing.md.txt"
|
|
title="View this page"
|
|
>
|
|
<svg><use href="#svg-eye"></use></svg>
|
|
<span class="visually-hidden">View this page</span>
|
|
</a>
|
|
</div>
|
|
<div class="theme-toggle-container theme-toggle-content">
|
|
<button
|
|
class="theme-toggle"
|
|
aria-label="Toggle Light / Dark / Auto color theme"
|
|
>
|
|
<svg class="theme-icon-when-auto-light">
|
|
<use href="#svg-sun-with-moon"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-auto-dark">
|
|
<use href="#svg-moon-with-sun"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-dark">
|
|
<use href="#svg-moon"></use>
|
|
</svg>
|
|
<svg class="theme-icon-when-light">
|
|
<use href="#svg-sun"></use>
|
|
</svg>
|
|
</button>
|
|
</div>
|
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
<span class="icon"
|
|
><svg><use href="#svg-toc"></use></svg
|
|
></span>
|
|
</label>
|
|
</div>
|
|
<article role="main" id="furo-main-content">
|
|
<section id="contributor-guide">
|
|
<h1>
|
|
Contributor Guide<a
|
|
class="headerlink"
|
|
href="#contributor-guide"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h1>
|
|
<p>
|
|
Thank you for your interest in improving this project. This
|
|
project is open-source under the
|
|
<a
|
|
class="reference external"
|
|
href="https://opensource.org/licenses/MIT"
|
|
>MIT license</a
|
|
>
|
|
and welcomes contributions in the form of bug reports, feature
|
|
requests, and pull requests.
|
|
</p>
|
|
<p>Here is a list of important resources for contributors:</p>
|
|
<ul class="simple">
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend"
|
|
>Source Code</a
|
|
>
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://backend.readthedocs.io/"
|
|
>Documentation</a
|
|
>
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend/issues"
|
|
>Issue Tracker</a
|
|
>
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a class="reference internal" href="codeofconduct.html"
|
|
><span class="doc std std-doc">Code of Conduct</span></a
|
|
>
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
<section id="how-to-report-a-bug">
|
|
<h2>
|
|
How to report a bug<a
|
|
class="headerlink"
|
|
href="#how-to-report-a-bug"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<p>
|
|
Report bugs on the
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend/issues"
|
|
>Issue Tracker</a
|
|
>.
|
|
</p>
|
|
<p>
|
|
When filing an issue, make sure to answer these questions:
|
|
</p>
|
|
<ul class="simple">
|
|
<li>
|
|
<p>
|
|
Which operating system and Python version are you using?
|
|
</p>
|
|
</li>
|
|
<li><p>Which version of this project are you using?</p></li>
|
|
<li><p>What did you do?</p></li>
|
|
<li><p>What did you expect to see?</p></li>
|
|
<li><p>What did you see instead?</p></li>
|
|
</ul>
|
|
<p>
|
|
The best way to get your bug fixed is to provide a test
|
|
case, and/or steps to reproduce the issue.
|
|
</p>
|
|
</section>
|
|
<section id="how-to-request-a-feature">
|
|
<h2>
|
|
How to request a feature<a
|
|
class="headerlink"
|
|
href="#how-to-request-a-feature"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<p>
|
|
Request features on the
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend/issues"
|
|
>Issue Tracker</a
|
|
>.
|
|
</p>
|
|
</section>
|
|
<section id="how-to-set-up-your-development-environment">
|
|
<h2>
|
|
How to set up your development environment<a
|
|
class="headerlink"
|
|
href="#how-to-set-up-your-development-environment"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<p>You need Python 3.7+ and the following tools:</p>
|
|
<ul class="simple">
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://python-poetry.org/"
|
|
>Poetry</a
|
|
>
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://nox.thea.codes/"
|
|
>Nox</a
|
|
>
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
<a
|
|
class="reference external"
|
|
href="https://nox-poetry.readthedocs.io/"
|
|
>nox-poetry</a
|
|
>
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
<p>Install the package with development requirements:</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>poetry<span class="w"> </span>install
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
You can now run an interactive Python session, or the
|
|
command-line interface:
|
|
</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>poetry<span class="w"> </span>run<span class="w"> </span>python
|
|
<span class="gp">$ </span>poetry<span class="w"> </span>run<span class="w"> </span>backend
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section id="how-to-test-the-project">
|
|
<h2>
|
|
How to test the project<a
|
|
class="headerlink"
|
|
href="#how-to-test-the-project"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<p>Run the full test suite:</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>nox
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<p>List the available Nox sessions:</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>nox<span class="w"> </span>--list-sessions
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
You can also run a specific Nox session. For example, invoke
|
|
the unit test suite like this:
|
|
</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>nox<span class="w"> </span>--session<span class="o">=</span>tests
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
Unit tests are located in the <em>tests</em> directory, and
|
|
are written using the
|
|
<a
|
|
class="reference external"
|
|
href="https://pytest.readthedocs.io/"
|
|
>pytest</a
|
|
>
|
|
testing framework.
|
|
</p>
|
|
</section>
|
|
<section id="how-to-submit-changes">
|
|
<h2>
|
|
How to submit changes<a
|
|
class="headerlink"
|
|
href="#how-to-submit-changes"
|
|
title="Link to this heading"
|
|
>¶</a
|
|
>
|
|
</h2>
|
|
<p>
|
|
Open a
|
|
<a
|
|
class="reference external"
|
|
href="https://github.com/xlorepdarkhelm/backend/pulls"
|
|
>pull request</a
|
|
>
|
|
to submit changes to this project.
|
|
</p>
|
|
<p>
|
|
Your pull request needs to meet the following guidelines for
|
|
acceptance:
|
|
</p>
|
|
<ul class="simple">
|
|
<li>
|
|
<p>
|
|
The Nox test suite must pass without errors and
|
|
warnings.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
Include unit tests. This project maintains 100% code
|
|
coverage.
|
|
</p>
|
|
</li>
|
|
<li>
|
|
<p>
|
|
If your changes add functionality, update the
|
|
documentation accordingly.
|
|
</p>
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Feel free to submit early, though—we can always iterate on
|
|
this.
|
|
</p>
|
|
<p>
|
|
To run linting and code formatting checks before committing
|
|
your change, you can install pre-commit as a Git hook by
|
|
running the following command:
|
|
</p>
|
|
<div class="highlight-console notranslate">
|
|
<div class="highlight">
|
|
<pre><span></span><span class="gp">$ </span>nox<span class="w"> </span>--session<span class="o">=</span>pre-commit<span class="w"> </span>--<span class="w"> </span>install
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<p>
|
|
It is recommended to open an issue before starting work on
|
|
anything. This will allow a chance to talk it over with the
|
|
owners and validate your approach.
|
|
</p>
|
|
</section>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
<footer>
|
|
<div class="related-pages">
|
|
<a class="next-page" href="codeofconduct.html">
|
|
<div class="page-info">
|
|
<div class="context">
|
|
<span>Next</span>
|
|
</div>
|
|
<div class="title">Contributor Covenant Code of Conduct</div>
|
|
</div>
|
|
<svg class="furo-related-icon">
|
|
<use href="#svg-arrow-right"></use>
|
|
</svg>
|
|
</a>
|
|
<a class="prev-page" href="reference.html">
|
|
<svg class="furo-related-icon">
|
|
<use href="#svg-arrow-right"></use>
|
|
</svg>
|
|
<div class="page-info">
|
|
<div class="context">
|
|
<span>Previous</span>
|
|
</div>
|
|
|
|
<div class="title">Reference</div>
|
|
</div>
|
|
</a>
|
|
</div>
|
|
<div class="bottom-of-page">
|
|
<div class="left-details">
|
|
<div class="copyright">Copyright © 2025, Cliff Hill</div>
|
|
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and
|
|
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a
|
|
>'s
|
|
|
|
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
</div>
|
|
<div class="right-details"></div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
<aside class="toc-drawer">
|
|
<div class="toc-sticky toc-scroll">
|
|
<div class="toc-title-container">
|
|
<span class="toc-title"> On this page </span>
|
|
</div>
|
|
<div class="toc-tree-container">
|
|
<div class="toc-tree">
|
|
<ul>
|
|
<li>
|
|
<a class="reference internal" href="#">Contributor Guide</a>
|
|
<ul>
|
|
<li>
|
|
<a
|
|
class="reference internal"
|
|
href="#how-to-report-a-bug"
|
|
>How to report a bug</a
|
|
>
|
|
</li>
|
|
<li>
|
|
<a
|
|
class="reference internal"
|
|
href="#how-to-request-a-feature"
|
|
>How to request a feature</a
|
|
>
|
|
</li>
|
|
<li>
|
|
<a
|
|
class="reference internal"
|
|
href="#how-to-set-up-your-development-environment"
|
|
>How to set up your development environment</a
|
|
>
|
|
</li>
|
|
<li>
|
|
<a
|
|
class="reference internal"
|
|
href="#how-to-test-the-project"
|
|
>How to test the project</a
|
|
>
|
|
</li>
|
|
<li>
|
|
<a
|
|
class="reference internal"
|
|
href="#how-to-submit-changes"
|
|
>How to submit changes</a
|
|
>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
|
|
</body>
|
|
</html>
|