Gutt Dokumentatioun suergt bei mgpy dofir, datt CLI, API a Release-Artefakter déi selwecht Geschicht erzielen. Feelend Doku kascht Support- an Integratiounsopwand.
Kaerpunkten
- CLI: Ënner Windows weisen d'Beispiller de recommandéierte Start iwwer
py -3.12 -m <modul> ...(z.B.py -3.12 -m manifestguard ...). Ënner Linux/macOS ass dat normalerweispython3.12 -m .... - README, Installatiounsguide an Docstrings mussen dee selwechten Entréewee beschreiwen.
- Ëffentlech APIe sollen Return-Wäerter, Feelerfäll an Beispill-Opriff dokumentéieren.
- Dokumentatioun gehéiert an d Release-Pipeline an net an eng spéider Nofleeg no engem Merge.
Recommandeierte mgpy-Workflow
- Als éischt déi ëffentlech CLI- an API-Weeër dokumentéieren, déi extern Notzer wierklech gesinn.
- Duerno Implementéierungsdetailer, ADRen a Spezial-Workflows ergänzen.
- Virun engem Release kontrolléieren, ob README, INSTALLATION an CI-Beispiller nach ëmmer déi selwecht Kommandoe weisen.
Schnellstart
py -3.12 -m manifestguard check --extended
py -3.12 -m manifestguard schema --output openapi.json
py -3.12 run_manifestguard.py --report .manifestguard/manifestguard-report.json