This commit is contained in:
github-actions[bot] 2022-09-23 06:23:55 +00:00
parent d922ed5b16
commit 6f5a7d472b
44 changed files with 745 additions and 5362 deletions

View file

@ -287,7 +287,7 @@
<li class="md-tabs__item">
<a href="./" class="md-tabs__link md-tabs__link--active">
<a href="../general/" class="md-tabs__link md-tabs__link--active">
Contributing
</a>
</li>
@ -1328,6 +1328,20 @@
<li class="md-nav__item">
<a href="../general/" class="md-nav__link">
General Information
</a>
</li>
@ -1395,48 +1409,6 @@
<li class="md-nav__item">
<a href="../coding-style/" class="md-nav__link">
Coding Style
</a>
</li>
<li class="md-nav__item">
<a href="../tests/" class="md-nav__link">
Tests
</a>
</li>
<li class="md-nav__item">
<a href="../documentation/" class="md-nav__link">
Documentation
</a>
</li>
</ul>
</nav>
</li>
@ -1558,25 +1530,21 @@
<p>By raising issues, I agree to these terms and I understand, that the rules set for the issue tracker will help both maintainers as well as everyone to find a solution.</p>
<p>Maintainers take the time to improve on this project and help by solving issues together. It is therefore expected from others to make an effort and <strong>comply with the rules</strong>.</p>
<h2 id="pull-requests"><a class="toclink" href="#pull-requests">Pull Requests</a></h2>
<h3 id="submit-a-pull-request"><a class="toclink" href="#submit-a-pull-request">Submit a Pull-Request</a></h3>
<div class="admonition question">
<p class="admonition-title">Motivation</p>
<p>You want to add a feature? Feel free to start creating an issue explaining what you want to do and how you're thinking doing it. Other users may have the same need and collaboration may lead to better results.</p>
</div>
<h3 id="submit-a-pull-request"><a class="toclink" href="#submit-a-pull-request">Submit a Pull-Request</a></h3>
<p>The development workflow is the following:</p>
<ol>
<li>Fork the project and clone your fork</li>
<li>Create a new branch to work on</li>
<li>Run <code>git submodule update --init --recursive</code></li>
<li>Fork the project and clone your fork with <code>git clone --recurse-submodules ...</code> or run <code>git submodule update --init --recursive</code> after you cloned your fork</li>
<li>Write the code that is needed :D</li>
<li>Add integration tests if necessary</li>
<li><a href="../tests/">Prepare your environment and run linting and tests</a></li>
<li>Document your improvements if necessary (e.g. if you introduced new environment variables, describe those in the <a href="../../config/environment/">ENV documentation</a>)</li>
<li><a href="https://help.github.com/articles/closing-issues-via-commit-messages/">Commit</a> and <a href="https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key">sign your commit</a>, push and create a pull-request to merge into <code>master</code>. Please <strong>use the pull-request template</strong> to provide a minimum of contextual information and make sure to meet the requirements of the checklist.</li>
<li>Pull requests are automatically tested against the CI and will be reviewed when tests pass</li>
<li>When your changes are validated, your branch is merged</li>
<li>CI builds the new <code>:edge</code> image immediately and your changes will be includes in the next version release.</li>
<li><a href="../general/#tests">Prepare your environment and run linting and tests</a></li>
<li>Document your improvements if necessary (e.g. if you introduced new environment variables, describe those in the <a href="../../config/environment/">ENV documentation</a>) and add your changes the changelog under the "Unreleased" section</li>
<li><a href="https://help.github.com/articles/closing-issues-via-commit-messages/">Commit</a> (and <a href="https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key">sign your commit</a>), push and create a pull-request to merge into <code>master</code>. Please <strong>use the pull-request template</strong> to provide a minimum of contextual information and make sure to meet the requirements of the checklist.</li>
</ol>
<p>Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new <code>:edge</code> image immediately and your changes will be includes in the next version release.</p>
</article>
@ -1597,7 +1565,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../../faq/" class="md-footer__link md-footer__link--prev" aria-label="Previous: FAQ" rel="prev">
<a href="../general/" class="md-footer__link md-footer__link--prev" aria-label="Previous: General Information" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</div>
@ -1606,27 +1574,12 @@
<span class="md-footer__direction">
Previous
</span>
FAQ
General Information
</div>
</div>
</a>
<a href="../coding-style/" class="md-footer__link md-footer__link--next" aria-label="Next: Coding Style" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Coding Style
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">