Architecture Decision Record

Active theme: Light

← dokumenter

Konventioner for filnavne

Hvis du vælger at skrive ADR'er som almindelige tekstfiler, kan det være nyttigt at fastlægge din egen konvention for ADR-filnavne.

Vi foretrækker en konvention for filnavne med et bestemt format.

Eksempler:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Vores konvention for filnavne:

  • Navnet er en bydemåde i nutid. Det forbedrer læsbarheden og passer til vores format for commit-beskeder.

  • Navnet bruger små bogstaver og bindestreger (ligesom i dette repository). Det er en balance mellem læsbarhed og brugbarhed på tværs af systemer.

  • Filendelsen er markdown. Det kan være praktisk til enkel formatering.