Architecture Decision Record

Active theme: Light

← dokumentai

ADR failų pavadinimų konvencijos

Jei nusprendėte kurti ADR naudodami įprastus tekstinius failus, galbūt norėsite susikurti savo ADR failų pavadinimų konvenciją.

Mes teikiame pirmenybę failų pavadinimų konvencijai, turinčiai konkretų formatą.

Pavyzdžiai:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Mūsų failų pavadinimų konvencija:

  • Pavadinime yra tiesioginės nuosakos veiksmažodžio frazė esamuoju laiku. Tai gerina skaitomumą ir atitinka mūsų įkėlimo pranešimų (angl. commit message) formatą.

  • Pavadinime naudojamos mažosios raidės ir brūkšneliai (kaip ir šioje saugykloje). Tai skaitomumo ir sistemos patogumo pusiausvyra.

  • Plėtinys yra markdown. Tai gali būti naudinga, kad formatuoti būtų lengva.