Architecture Decision Record

Active theme: Light

← documenten

Conventies voor bestandsnamen

Als je ervoor kiest ADR's als platte tekstbestanden te schrijven, kan het nuttig zijn een eigen conventie voor ADR-bestandsnamen vast te stellen.

Wij geven de voorkeur aan een conventie voor bestandsnamen met een specifiek formaat.

Voorbeelden:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Onze conventie voor bestandsnamen:

  • De naam is een gebiedende wijs in de tegenwoordige tijd. Dit verbetert de leesbaarheid en komt overeen met ons formaat voor commitberichten.

  • De naam gebruikt kleine letters en streepjes (hetzelfde als in deze repository). Dit is een balans tussen leesbaarheid en bruikbaarheid in systemen.

  • De extensie is markdown. Dit kan handig zijn voor eenvoudige opmaak.