Architecture Decision Record

Active theme: Light

← dokumenty

Konvence pojmenování souborů ADR

Pokud se rozhodnete vytvářet ADR v běžných textových souborech, možná budete chtít vymyslet vlastní konvenci pojmenování souborů ADR.

My preferujeme konvenci pojmenování souborů s určitým formátem.

Příklady:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Naše konvence pojmenování souborů:

  • Název obsahuje slovesnou frázi v rozkazovacím způsobu (v angličtině přítomný čas). Zlepšuje to čitelnost a odpovídá to formátu našich zpráv commitů.

  • Název používá malá písmena a pomlčky (stejně jako tento repozitář). Je to kompromis mezi čitelností a použitelností v systému.

  • Přípona je markdown. To může být užitečné pro snadné formátování.