Allgemeine Richtlinien

Grundlegende Vorgaben für Team- und Projektdokumentation.

info

Jede*r ist eingeladen, Veränderungen vorzuschlagen bzw. umzusetzen - besonders in diesem Dokument!

Sprache

• Dokumentation und Spiel sind in Deutscher Sprache zu halten, da der internationale Kontext fehlt.
• Commits, Issues, PRs und Code auf Englisch gem. industrieller Konvention.
• Nutze respektvolle Sprache¹.

Arbeitsweise

• Was nicht aufgeschrieben ist, existiert nicht. Das gilt für alle Bereiche (Arbeitspakete, Features, Notizen für Präsentationen etc.):
  • Pflege deine Notizen hier im Repo oder zunächst lokal.
  • Verlinke relevante Inhalte, um Dritten einen schnellen Überblick zu ermöglichen.
• Halte Arbeitspakete so klein wie möglich und zerteile zu umfangreiche Aufgaben.
• Commits:
  • Im Imperativ formuliert².
  • Aussagekräftige Commit-Messages (Conventional Commits bevorzugt³).

LLM-Nutzung & saubere Texte

• Kein Slop: Achte darauf, dass Arbeit, die du pushst oder zur Review freigibst, sinnvoll und gut zu überblicken ist.
• Siehe AGENTS.md im Repository-Root für Vorgaben zur Typografie (keine Em- oder En-Dashes, keine typografischen Anführungszeichen) und zur Vermeidung typischer KI-Artefakte.

Quellen und weitere Ressourcen

• https://www.writethedocs.org/guide/writing/style-guides/

Footnotes

1. https://inclusivenaming.org/ ↩

2. Bitte lies: https://gist.github.com/marcelkraus/d32aa6b96731cd3e5bf8b4938d5a7b66 ↩

3. Conventional Commits Cheat Sheet: https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13 ↩