Соглашения об именовании файлов

Если вы решили создавать ADR в обычных текстовых файлах, вам, возможно, стоит выработать собственное соглашение об именовании файлов ADR.

Мы предпочитаем соглашение об именовании файлов, имеющее определённый формат.

Примеры:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Наше соглашение об именовании файлов:

• Имя содержит глагольную фразу в повелительном наклонении настоящего времени. Это улучшает читаемость и соответствует формату наших сообщений коммитов.

• В имени используются строчные буквы и дефисы (как и в этом репозитории). Это баланс между читаемостью и удобством использования в системе.

• Расширение — markdown. Это может быть полезно для простого форматирования.