Конвенции за именуване на файлове за ADR

Ако решите да създавате своите ADR с типични текстови файлове, може да искате да изработите собствена конвенция за именуване на файловете за ADR.

Предпочитаме да използваме конвенция за именуване на файлове със специфичен формат.

Примери:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Нашата конвенция за именуване на файлове:

• Името съдържа глаголна фраза в повелително наклонение в сегашно време. Това подобрява четливостта и съответства на формата на нашите съобщения за комит.

• Името използва малки букви и тирета (както в това хранилище). Това е баланс между четливост и използваемост на системата.

• Разширението е markdown. Това може да е полезно за лесно форматиране.