Правила іменування файлів для ADR

Якщо ви вирішили створювати ADR у звичайних текстових файлах, вам може знадобитися власне правило іменування файлів ADR.

Ми віддаємо перевагу правилу іменування файлів із чітким форматом.

Приклади:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Наше правило іменування файлів:

• Назва містить дієслівну фразу в наказовому способі теперішнього часу. Це покращує читабельність і відповідає формату наших повідомлень комітів.

• Назва використовує малі літери та дефіси (як і в цьому репозиторії). Це баланс між читабельністю та зручністю використання в системі.

• Розширення — markdown. Це може бути корисним для легкого форматування.