Failinimede konventsioonid

Kui otsustad kirjutada ADR-e lihttekstifailidena, võib olla kasulik kehtestada oma ADR-i failinimede konventsioon.

Eelistame kindla vorminguga failinimede konventsiooni.

Näited:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Meie failinimede konventsioon:

• Nimi on käskiva kõneviisi verbifraas olevikus. See parandab loetavust ja sobib meie commit-sõnumite vorminguga.

• Nimi kasutab väiketähti ja sidekriipse (nagu selles hoidlas). See on tasakaal loetavuse ja süsteemide kasutatavuse vahel.

• Laiend on markdown. See võib olla mugav lihtsa vormindamise jaoks.