Open MarkusTiede opened 5 days ago
Danke auch für deine erste Gewichtung! Hier mal meine möglichen Qualitätskriterien sortiert nach Property (ohne bereits viele Example-Requirements aufzuführen):
#reliable
#flexible
#usable
.
#suitable
Aktualisiert die Datei README.md, welche im Wurzelverzeichnis eures Repositories liegt
Beschreibt so kurz wie nötig wozu und wie die App verwendet werden kann.
Dokumentiert wie das Projekt von einem Nutzer aufgesetzt werden kann. Beschreibt die Schritte von `git clone` bis zu `npm run develop` oder `npm run start`.
Dokumentiert ggf. von euch verwendete 3rd-Party Libraries. Das ist z.B. wichtig für neue Entwickler*innen.
Diese Anleitung gibt euch gute Anhaltspunkte: https://www.freecodecamp.org/news/how-to-write-a-good-readme-file/
https://github.com/digital-sustainability/module-wseg/blob/c969f4de8d0e72a01709eb50146886cba70e5b27/docs/slides/content/04/01.md?plain=1#L67-L70