mocode-software/meldestelle
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

upgrade(docker)

Browse Source
This commit is contained in:
stefan
2025-08-16 15:47:57 +02:00
parent 1ef14a3692
commit 9c21154199
48 changed files with 6250 additions and 549 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.junie/guidelines/master-guideline.md
+20
View File
@@ -159,3 +159,23 @@ Migrations-Skripte müssen einer klaren Namenskonvention folgen.
Alle öffentlichen REST-Endpunkte müssen mit OpenAPI-Annotationen (`@Operation`, `@ApiResponse`) dokumentiert werden, um
eine klare und interaktive API-Dokumentation zu generieren.
---
## 7. Dokumentationsstandards
### 7.1. Sprache für Dokumentation
* **README-Dateien:** Alle README-Dokumentationen im Projekt müssen in **deutscher Sprache** verfasst werden.
Dies gewährleistet Konsistenz und Zugänglichkeit für das deutsche Entwicklungsteam.
* **Code-Kommentare:** Komplexe Geschäftslogik und fachliche Zusammenhänge sollen in deutscher Sprache kommentiert werden.
* **API-Dokumentation:** OpenAPI-Beschreibungen und -Beispiele sind bevorzugt in deutscher Sprache zu verfassen,
sofern keine internationalen Anforderungen bestehen.
### 7.2. Dokumentationsstruktur
* README-Dateien sollen eine einheitliche Struktur befolgen: Überblick, Architektur, Entwicklung, Tests, Deployment.
* Technische Begriffe dürfen in englischer Originalform verwendet werden, wenn keine etablierte deutsche Übersetzung existiert.