ADR-fájlnév-konvenciók

Ha az ADR-eket hagyományos szövegfájlokban hozza létre, érdemes kialakítania a saját ADR-fájlnév-konvencióját.

Mi egy meghatározott formátumú fájlnév-konvenciót részesítünk előnyben.

Példák:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

A mi fájlnév-konvenciónk:

• A név egy felszólító módú igei kifejezést tartalmaz (angolul jelen idő). Ez javítja az olvashatóságot, és illeszkedik a commitüzeneteink formátumához.

• A név kisbetűket és kötőjeleket használ (mint ez a tároló). Ez egyensúly az olvashatóság és a rendszerben való használhatóság között.

• A kiterjesztés markdown. Ez hasznos lehet az egyszerű formázáshoz.