Update tox workflow #24

.github/workflows/codecov.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   test:
-    name: Run tests and create codecov
+    name: Run coverage test and create codecov
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -23,7 +23,7 @@ jobs:
       - name: Install dependencies
         run: pip install pytest pytest-cov
 
-      - name: Run tests
+      - name: Run coverage test
         run: pytest --cov --cov-report=xml
 
       - name: Upload results to Codecov

.github/workflows/automated-testing.yml → .github/workflows/tox.yml

@@ -2,7 +2,7 @@
 # SPDX-FileCopyrightText: 2023 Jonas Huber <https://github.com/jh-rli> © Reiner Lemoine Institut
 # SPDX-License-Identifier: MIT
 
-name: automated-testing
+name: tox
 
 on:
   push:
@@ -13,7 +13,6 @@ on:
 jobs:
   test:
     strategy:
-      # fail-fast: false
       matrix:
         platform: [ubuntu-latest, windows-latest]
         python-version: ['3.10']
@@ -39,5 +38,5 @@ jobs:
         python -m pip install --upgrade pip setuptools wheel
         pip install tox tox-gh-actions
 
-    - name: tox unit tests
+    - name: Run tox unit tests
       run: tox -e ${{ matrix.tox-envs }}

CONTRIBUTING.md

@@ -118,6 +118,7 @@ Examples of branch names: `feature-42-add-new-ontology-class`, `feature-911-bran
 
 - Divide your feature into small logical units
 - Start to write the documentation or a docstring
+- Write a unit test that covers the desired outputs and possible errors
 - Don't rush, have the commit messages in mind
 - Add your changes to the CHANGELOG.md
 

README.rst

@@ -20,7 +20,7 @@ super-repo
    * - License
      - |badge_license| |badge_reuse|
    * - Documentation
-     - |badge_documentation| |badge_tests| |badge_codecov|
+     - |badge_documentation| |badge_tox| |badge_codecov|
    * - Publication
      - |badge_pypi| |badge_python| |badge_pypi_downloads|
    * - Development
@@ -78,8 +78,8 @@ License and Citation
     :target: https://rl-institut.github.io/super-repo/
     :alt: Documentation
 
-.. |badge_tests| image:: https://github.com/rl-institut/super-repo/actions/workflows/automated-testing.yml/badge.svg
-    :target: https://github.com/rl-institut/super-repo/actions/workflows/automated-testing.yml
+.. |badge_tox| image:: https://github.com/rl-institut/super-repo/actions/workflows/tox.yml/badge.svg
+    :target: https://github.com/rl-institut/super-repo/actions/workflows/tox.yml
     :alt: Documentation
 
 .. |badge_codecov| image:: https://codecov.io/gh/rl-institut/super-repo/graph/badge.svg?token=YYCJI3D5G5