Kleine änderungen an pre-commits und readme

Einige pre-commits hinzugefügt und in der README dokumentiert.
Eine Pre-commit installationsanleitung wurde zur readme hinzugefügt.
Spellchecker and Markdown whitespace table format
This commit is contained in:
2023-04-12 23:46:41 +02:00
parent a79c5b6560
commit b1bfbe9c2c
4 changed files with 68 additions and 20 deletions

View File

@ -1,2 +1,25 @@
# aki_prj23_transparenzregister
## Aufsetzen des Project zur Entwicklung
- clone des Projects
- installieren der folgenden Python Packete:
- `pre-commit`
- führe das kommando `pre-commit install` aus um die pre-commit hooks für das repository zu aktiviere.
- für weiterführende Informationen [Python Pre-Commit](https://pre-commit.com/)
- Folgende Formats-konventionen wurden so implementiert
- Whitespace formatierung:
- Python: Black
- leading whitespace
- Auto framat yaml, toml, ini
- Import nomierung
- isort
- absolutify
- Validierung
- yaml, toml, json, xml
- Secret detection
- python normen
- type checking
- pep8 (flake8)
- file schemas