Dateinamenskonventionen

Wenn Sie Ihre ADRs als gewöhnliche Textdateien erstellen, möchten Sie vielleicht eine eigene Dateinamenskonvention für ADR-Dateien festlegen.

Wir bevorzugen eine Dateinamenskonvention mit einem bestimmten Format.

Beispiele:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Unsere Dateinamenskonvention:

• Der Name besteht aus einer Verbalphrase im Imperativ der Gegenwart. Das verbessert die Lesbarkeit und passt zu unserem Format für Commit-Nachrichten.

• Der Name verwendet Kleinbuchstaben und Bindestriche (wie dieses Repository). Das ist ein Kompromiss zwischen Lesbarkeit und Systemtauglichkeit.

• Die Erweiterung ist Markdown. Das kann für eine einfache Formatierung nützlich sein.