diff --git a/.pre-commit-config.yml b/.pre-commit-config.yml index 6e86a62..81fb4de 100644 --- a/.pre-commit-config.yml +++ b/.pre-commit-config.yml @@ -21,6 +21,10 @@ repos: - id: check-case-conflict - id: check-symlinks - id: check-docstring-first + - id: mixed-line-ending + - id: destroyed-symlinks + - id: debug-statements + - id: pretty-format-json - repo: https://github.com/psf/black rev: 22.10.0 @@ -38,6 +42,10 @@ repos: args: [--autofix] - id: pretty-format-yaml args: [--autofix] + - id: pretty-format-toml + args: [ --autofix ] + exclude: (^poetry.lock$) + - repo: https://github.com/domdfcoding/flake2lint rev: v0.4.2 @@ -75,3 +83,20 @@ repos: hooks: - id: pyupgrade args: [--py311-plus] + +- repo: https://github.com/pylint-dev/pylint + rev: v3.0.0a6 + hooks: [] + # - id: pylint + # args: [--disable=import-error] + +- repo: https://github.com/MarcoGorelli/absolufy-imports + rev: v0.3.1 + hooks: + - id: absolufy-imports + +- repo: https://github.com/pycqa/isort + rev: 5.12.0 + hooks: + - id: isort + name: isort (python) diff --git a/README.md b/README.md index 0ae0437..b5f3276 100644 --- a/README.md +++ b/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 diff --git a/documentations/meeting-notes/Meeting_30-03-2023.md b/documentations/meeting-notes/Meeting_30-03-2023.md index 8e016f9..45da2c0 100644 --- a/documentations/meeting-notes/Meeting_30-03-2023.md +++ b/documentations/meeting-notes/Meeting_30-03-2023.md @@ -23,7 +23,7 @@ - Backlog für Ideen und Aufgaben - Meeting-Notes mit besprochenen Themen, Entscheidungen, Terminen und Action-List (Wer arbeitet an welcher Aufgabe?) - Projektdurchführung so formal wie möglich, d.h. - - Beschreibung des Systemkontext: Interaktion mit der Umgebung + - Beschreibung des Systemkontexts: Interaktion mit der Umgebung - Datenmodell: schematische Darstellung der Datenflüsse - Lasten- / Pflichtenheft mit Kategorisierung - Vorschlag Frontend von Prof. Arinir: D3.js @@ -31,16 +31,16 @@ - **Bewertung des Projekts:** - Es muss erkennbar sein, wer welche Aufgabe bearbeitet hat - Jeder Teilnehmer soll die Aufgaben der anderen Teilnehmer kennen und ein Verständnis für diese haben (kein tiefes Domänenwissen!) - - Gesamtplanung und Dokumentation sind Teil des Ergebnis, nicht nur die technische Umsetzung + - Gesamtplanung und Dokumentation sind Teil das Ergebnis, nicht nur die technische Umsetzung - Bewertungsschlüssel: -| Gewichtung | Aufgabe | -|---|---| -| 20% | Vortrag Seminararbeit | -| 20% | Präsentation | -| 30% | Implementierung | -| 20% | Finaler Bericht (~15 Seiten pro Teilnehmer)| -| 10% | Abschlusspräsentation | +| Gewichtung | Aufgabe | +|--------------|---------------------------------------------| +| 20% | Vortrag Seminararbeit | +| 20% | Präsentation | +| 30% | Implementierung | +| 20% | Finaler Bericht (~15 Seiten pro Teilnehmer) | +| 10% | Abschlusspräsentation | - **Organisatorisches:** - Regeltermin alle 14 Tage mit allen Projektteilnehmern, beginnend am 30.03.2023: Dieser Termin soll für Sprint Planning und Review mit Prof. Arinir genutzt werden. @@ -52,11 +52,11 @@ ## Abgeleitete Action Items -| Action Item | Verantwortlicher | Deadline | -| ----------- | ---------------- | -------- | -| Welche Anforderungen / Erwartungen stellen wir inhaltlich und technisch an das Projekt?| alle | nächstes Weekly/work in progress | -| Erarbeiten von Arbeitspaketen/Aufgaben aus Anforderungen| alle | nächstes Weekly/work in progress | -| Welche Metriken sind notwendig?| alle | nächstes Weekly/work in progress | -| Recherche zu Datenquellen| alle | nächstes Weekly/work in progress | -| Definition von Meilensteinen| alle | nächstes Weekly | -| Erstellung eines (groben) Zeitplans| alle | nächstes Weekly | +| Action Item | Verantwortlicher | Deadline | +|-----------------------------------------------------------------------------------------|--------------------|----------------------------------| +| Welche Anforderungen / Erwartungen stellen wir inhaltlich und technisch an das Projekt? | alle | nächstes Weekly/work in progress | +| Erarbeiten von Arbeitspaketen/Aufgaben aus Anforderungen | alle | nächstes Weekly/work in progress | +| Welche Metriken sind notwendig? | alle | nächstes Weekly/work in progress | +| Recherche zu Datenquellen | alle | nächstes Weekly/work in progress | +| Definition von Meilensteinen | alle | nächstes Weekly | +| Erstellung eines (groben) Zeitplans | alle | nächstes Weekly | diff --git a/documentations/templates/meeting_notes_template.md b/documentations/templates/meeting_notes_template.md index c0c2695..da255ed 100644 --- a/documentations/templates/meeting_notes_template.md +++ b/documentations/templates/meeting_notes_template.md @@ -16,6 +16,6 @@ ## Abgeleitete Action Items -| Action Item | Verantwortlicher | Deadline | -| ----------- | ---------------- | -------- | -| Beispiel | Max Mustermann | nächstes Weekly | +| Action Item | Verantwortlicher | Deadline | +|-------------|------------------|-----------------| +| Beispiel | Max Mustermann | nächstes Weekly |