Architecture Decision Record

Active theme: Light

← dockiments

File name conventiouns for ADRs

If ye chuise tae mak yer ADRs uisin typical text files, than ye micht want tae come up wi yer ain ADR file name convention.

We prefer tae uise a file name convention that haes a specific format.

Examples:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Oor file name convention:

  • The name haes a present tense imperative verb phrase. This helps readability an matches oor commit message format.

  • The name uises lowercase an dashes (the same as this repo). This is a balance o readability an system uisability.

  • The extension is markdown. This can be uiseful for easy formattin.