Konwencje nazw plików ADR

Jeśli rejestry ADR tworzysz w zwykłych plikach tekstowych, warto opracować własną konwencję nazw plików ADR.

My wolimy konwencję nazw plików o określonym formacie.

Przykłady:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

Nasza konwencja nazw plików:

• Nazwa zawiera wyrażenie czasownikowe w trybie rozkazującym (angielski czas teraźniejszy). Poprawia to czytelność i odpowiada formatowi naszych komunikatów commitów.

• Nazwa używa małych liter i myślników (tak samo jak to repozytorium). To kompromis między czytelnością a wygodą użycia w systemie.

• Rozszerzenie to markdown. Ułatwia to formatowanie.