Architecture Decision Record

Active theme: Light

← documentos

Convenções de nomes de arquivo

Se você optar por criar seus ADRs usando arquivos de texto comuns, talvez queira definir sua própria convenção de nomes de arquivo de ADR.

Preferimos usar uma convenção de nomes de arquivo que tenha um formato específico.

Exemplos:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Nossa convenção de nomes de arquivo:

  • O nome tem uma locução verbal no imperativo do presente. Isso ajuda a legibilidade e combina com o formato das nossas mensagens de commit.

  • O nome usa letras minúsculas e hifens (igual a este repositório). É um equilíbrio entre legibilidade e usabilidade do sistema.

  • A extensão é markdown. Isso pode ser útil para formatar facilmente.