Konvencie pomenovania súborov ADR

Ak sa rozhodnete vytvárať svoje ADR pomocou typických textových súborov, možno si budete chcieť vymyslieť vlastnú konvenciu pomenovania súborov ADR.

Uprednostňujeme konvenciu pomenovania súborov so špecifickým formátom.

Príklady:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Naša konvencia pomenovania súborov:

• Názov obsahuje slovesnú frázu v rozkazovacom spôsobe v prítomnom čase. To pomáha čitateľnosti a zodpovedá to nášmu formátu správ commitov.

• Názov používa malé písmená a pomlčky (rovnako ako toto úložisko). Je to rovnováha medzi čitateľnosťou a použiteľnosťou systému.

• Prípona je markdown. To môže byť užitočné pre jednoduché formátovanie.