Architecture Decision Record

Active theme: Light

← dokumenti

Konvencije poimenovanja datotek za ADR

Če se odločite ustvarjati ADR s tipičnimi besedilnimi datotekami, si boste morda želeli izdelati lastno konvencijo poimenovanja datotek ADR.

Mi dajemo prednost konvenciji poimenovanja datotek z določeno obliko.

Primeri:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Naša konvencija poimenovanja datotek:

  • Ime vsebuje glagolsko zvezo v velelniku sedanjika. To izboljša berljivost in se ujema z obliko naših sporočil ob potrditvah.

  • Ime uporablja male črke in vezaje (enako kot ta repozitorij). To je ravnovesje med berljivostjo in uporabnostjo sistema.

  • Pripona je markdown. To je lahko koristno za preprosto oblikovanje.