Files
michaelschiemer/docs/standards/index.md

1.7 KiB

Coding-Standards und Richtlinien

Übersicht

Diese Standards und Richtlinien definieren die grundlegenden Prinzipien für die Codierung und Sicherheit im Projekt. Sie gewährleisten Konsistenz, Wartbarkeit und Sicherheit des Codes.

Verfügbare Standards

Coding Guidelines

Die Coding Guidelines definieren die technischen Standards für die Codeentwicklung, einschließlich:

  • Klassenstruktur und -design
  • Property- und Methodendefinitionen
  • Nutzung moderner PHP-Features
  • Fehlerbehandlung
  • Dokumentation
  • Namenskonventionen

Sicherheitsrichtlinien

Die Sicherheitsrichtlinien bieten umfassende Anleitungen zur sicheren Softwareentwicklung:

  • Input-Validierung
  • SQL-Injection-Prävention
  • XSS-Schutz
  • CSRF-Schutz
  • Sichere Authentifizierung
  • Sichere Datenspeicherung
  • Session-Management

Anwendung der Standards

Alle Teammitglieder sind verpflichtet, diese Standards in ihrer Arbeit anzuwenden. Sie dienen als Grundlage für Code-Reviews und Qualitätssicherung.

Abweichungen von Standards

In Ausnahmefällen können Abweichungen von diesen Standards erforderlich sein. Solche Abweichungen sollten:

  1. Dokumentiert werden
  2. Begründet werden
  3. Im Team besprochen werden
  4. Auf ein Minimum beschränkt werden

Aktualisierungen

Diese Standards werden regelmäßig überprüft und aktualisiert, um sicherzustellen, dass sie den neuesten Best Practices und Technologien entsprechen.