Architecture Decision Record

Active theme: Light

← documenti

Convenzioni per i nomi dei file

Se scegli di scrivere gli ADR come file di testo semplice, può essere utile stabilire una tua convenzione per i nomi dei file degli ADR.

Preferiamo una convenzione per i nomi dei file con un formato specifico.

Esempi:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

La nostra convenzione per i nomi dei file:

  • Il nome è una frase verbale all'imperativo presente. Questo migliora la leggibilità e corrisponde al nostro formato dei messaggi di commit.

  • Il nome usa lettere minuscole e trattini (come in questo repository). È un equilibrio tra leggibilità e usabilità nei sistemi.

  • L'estensione è markdown. Può essere utile per una formattazione semplice.