mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-06-22 00:23:55 +02:00
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:
23
README.md
23
README.md
@ -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
|
||||
|
Reference in New Issue
Block a user