Moved contribution rules and format documentation to CONTRIBUTING.md (#19)

* Moved contribution rules and format documentation to CONTRIBUTING.md
This commit is contained in:
2023-05-11 17:16:17 +02:00
committed by GitHub
parent 75f9964152
commit 3633594156
2 changed files with 38 additions and 22 deletions

View File

@@ -1,25 +1,5 @@
# aki_prj23_transparenzregister
## Aufsetzen des Project zur Entwicklung
## Contributions
- 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
See the [CONTRIBUTING.md](CONTRIBUTING.md) about how code should be formatted and what kind of rules we set ourselves.