Documentation and naming fixes (#74)

* some documentation and naming fixes

Signed-off-by: Christian Henkel <christian.henkel2@de.bosch.com>

* a whitespace

Signed-off-by: Christian Henkel <christian.henkel2@de.bosch.com>

---------

Signed-off-by: Christian Henkel <christian.henkel2@de.bosch.com>

Author: ct2034

.github/workflows/release.yml

@@ -1,9 +1,11 @@
+name: Release
 on:
     push:
         tags:
             - "[0-9]+.[0-9]+.[0-9]+"
 jobs:
     test:
+        name: py${{ matrix.python-version }} @ ${{ matrix.os }}
         strategy:
           fail-fast: true
           matrix:
@@ -47,6 +49,7 @@ jobs:
                 job-summary: true
 
     release:
+        name: Release
         runs-on: ubuntu-latest
         needs: test
         steps:

.github/workflows/todo-to-issue.yml

@@ -1,9 +1,9 @@
-name: "Run TODO to Issue"
+name: "TODO to Issue"
 on:
   push:
     branches: [ main ]
 jobs:
-    build:
+    todo_to_issue:
         runs-on: "ubuntu-latest"
         steps:
             - uses: "actions/checkout@v3"

how_to_release.md

@@ -0,0 +1,40 @@
+# Note for me
+
+## Requirements
+
+```bash
+pip install bumpver build twine
+```
+
+## Steps
+
+How to increase the version number:
+
+```bash
+git checkout main
+git pull
+bumpver update --patch  # or --minor or --major
+git push
+git push --tags
+```
+
+This triggers the CI to build and release the package.
+
+## ALL BELOW IS PERFORMED AUTOMATICALLY
+
+> **_ATTENTION:_**
+The following steps are performed automatically
+
+(by the [CI release job](.github/workflows/release.yml))
+
+If you want to release manually:
+
+```bash
+python -m build
+twine check dist/*
+twine upload dist/*  # user: ct2034_0
+```
+
+## source
+
+<https://realpython.com/pypi-publish-python-package/#build-your-package>