Architecture Decision Record

Active theme: Light

← dokumenti

Konvenzjonijiet tal-ismijiet tal-fajls għall-ADR

Jekk tagħżel li toħloq l-ADR tiegħek bi fajls tat-test tipiċi, forsi tixtieq tfassal il-konvenzjoni tiegħek għall-ismijiet tal-fajls tal-ADR.

Aħna nippreferu nużaw konvenzjoni għall-ismijiet tal-fajls li għandha format speċifiku.

Eżempji:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Il-konvenzjoni tagħna għall-ismijiet tal-fajls:

  • L-isem fih frażi verbali imperattiva fil-preżent. Dan jgħin il-qari u jaqbel mal-format tal-messaġġi tal-kommit tagħna.

  • L-isem juża ittri żgħar u trattini (bħal f'dan ir-repo). Dan huwa bilanċ bejn il-qari faċli u l-użabbiltà tas-sistema.

  • L-estensjoni hija markdown. Dan jista' jkun utli għal formattjar faċli.