Architecture Decision Record

Active theme: Light

← dokumenti

Konvencije imenovanja datoteka za ADR

Ako odlučite stvarati svoje ADR-ove pomoću tipičnih tekstualnih datoteka, možda ćete htjeti osmisliti vlastitu konvenciju imenovanja datoteka za ADR.

Preferiramo konvenciju imenovanja datoteka koja ima određeni format.

Primjeri:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Naša konvencija imenovanja datoteka:

  • Naziv sadrži glagolsku frazu u imperativu u sadašnjem vremenu. To pomaže čitljivosti i odgovara našem formatu poruka commita.

  • Naziv koristi mala slova i crtice (kao i ovaj repozitorij). To je ravnoteža između čitljivosti i upotrebljivosti sustava.

  • Ekstenzija je markdown. To može biti korisno za jednostavno oblikovanje.