Architecture Decision Record

Active theme: Light

← documente

Convenții de denumire a fișierelor ADR

Dacă alegi să creezi ADR-urile în fișiere text obișnuite, poate vrei să stabilești propria convenție de denumire a fișierelor ADR.

Noi preferăm o convenție de denumire cu un format anume.

Exemple:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Convenția noastră de denumire a fișierelor:

  • Numele conține o expresie verbală la imperativ (în engleză, timpul prezent). Aceasta îmbunătățește lizibilitatea și se potrivește cu formatul mesajelor noastre de commit.

  • Numele folosește litere mici și cratime (la fel ca acest depozit). Este un echilibru între lizibilitate și ușurința de utilizare în sistem.

  • Extensia este markdown. Aceasta poate fi utilă pentru formatare ușoară.