Filnamnskonventioner

Om du väljer att skapa dina ADR:er med vanliga textfiler kanske du vill ta fram en egen filnamnskonvention för ADR-filer.

Vi föredrar att använda en filnamnskonvention med ett specifikt format.

Exempel:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Vår filnamnskonvention:

• Namnet har en verbfras i imperativ presens. Det underlättar läsbarheten och matchar vårt format för commit-meddelanden.

• Namnet använder gemener och bindestreck (samma som detta repo). Det är en balans mellan läsbarhet och systemets användbarhet.

• Filändelsen är markdown. Det kan vara användbart för enkel formatering.