Skip to content

Commit

Permalink
Fix unit test again on Github CICD c3ff79d
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianWilhelm committed Dec 28, 2023
1 parent 60d46ef commit dd0791f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dev/contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@
</code></pre></div> and start making changes. Never work on the main branch!</p> </li> <li> <p>Start your work on this branch. Don't forget to add <a href=https://peps.python.org/pep-0257/ >docstrings</a> in <a href=https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings>Google style</a> to new functions, modules and classes, especially if they are part of public APIs.</p> </li> <li> <p>Add yourself to the list of contributors in <code>AUTHORS.md</code>.</p> </li> <li> <p>When you’re done editing, do: <div class=highlight><pre><span></span><code>git add &lt;MODIFIED FILES&gt;
git commit
</code></pre></div> to record your changes in <a href=https://git-scm.com/ >git</a>. <br> Please make sure to see the validation messages from <a href=https://pre-commit.com/ >pre-commit</a> and fix any eventual issues. This should automatically use <a href=https://flake8.pycqa.org/ >flake8</a>/<a href=https://black.readthedocs.io/ >black</a> to check/fix the code style in a way that is compatible with the project.</p> <div class="admonition info"> <p class=admonition-title>Info</p> <p>Don't forget to add unit tests and documentation in case your contribution adds a feature and is not just a bugfix.</p> <p>Moreover, writing an <a href=https://chris.beams.io/posts/git-commit>descriptive commit message</a> is highly recommended. In case of doubt, you can check the commit history with: <div class=highlight><pre><span></span><code>git log --graph --decorate --pretty=oneline --abbrev-commit --all
</code></pre></div> to look for recurring communication patterns.</p> </div> </li> <li> <p>Please check that your changes don't break any unit tests with <code>hatch run test:cov</code> or <code>hatch run test:no-cov</code> to run the unitest with or without coverage reports, respectively.</p> </li> <li>For code hygiene, execute <code>hatch run lint:all</code> in order to run <a href=https://flake8.pycqa.org/ >flake8</a>, <a href=https://pycqa.github.io/isort/ >isort</a>, <a href=https://black.readthedocs.io/ >black</a>, <a href=https://mypy-lang.org/ >mypy</a>, etc.</li> </ol> <h3 id=submit-your-contribution>Submit your contribution<a class=headerlink href=#submit-your-contribution title="Permanent link">&para;</a></h3> <ol> <li>If everything works fine, push your local branch to the remote server with:</li> </ol> <div class=highlight><pre><span></span><code>git push -u origin my-feature
</code></pre></div> to look for recurring communication patterns.</p> </div> </li> <li> <p>Please check that your changes don't break any unit tests with <code>hatch run cov</code> or <code>hatch run no-cov</code> to run the unitest with or without coverage reports, respectively.</p> </li> <li>For code hygiene, execute <code>hatch run lint:all</code> in order to run <a href=https://flake8.pycqa.org/ >flake8</a>, <a href=https://pycqa.github.io/isort/ >isort</a>, <a href=https://black.readthedocs.io/ >black</a>, <a href=https://mypy-lang.org/ >mypy</a>, etc.</li> </ol> <h3 id=submit-your-contribution>Submit your contribution<a class=headerlink href=#submit-your-contribution title="Permanent link">&para;</a></h3> <ol> <li>If everything works fine, push your local branch to the remote server with:</li> </ol> <div class=highlight><pre><span></span><code>git push -u origin my-feature
</code></pre></div> <ol> <li>Go to the web page of your fork and click "Create pull request" to send your changes for review.</li> </ol> <p>Find more detailed information in <a href=https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>creating a PR</a>. You might also want to open the PR as a draft first and mark it as ready for review after the feedbacks from the continuous integration (CI) system or any required fixes.</p> <!-- END INCLUDE --> <!--- Add here generic links that can be used in every md doc --> <div class=footnote> <hr> <ol> <li id=fn:contrib1> <p>Even though these resources focus on open source projects and communities, the general ideas behind collaborating with other developers to collectively create software are general and can be applied to all sorts of environments, including private companies and proprietary code bases.&#160;<a class=footnote-backref href=#fnref:contrib1 title="Jump back to footnote 1 in the text">&#8617;</a></p> </li> </ol> </div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; Florian Wilhelm 2023-present </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/FlorianWilhelm/pytanis target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "..", "features": ["navigation.sections", "navigation.tabs.sticky", "navigation.instant"], "search": "../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../assets/javascripts/bundle.d7c377c4.min.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html>
2 changes: 1 addition & 1 deletion dev/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit dd0791f

Please sign in to comment.