Architecture Decision Record

Active theme: Light

← documents

Conventions de nommage des fichiers

Si vous choisissez de créer vos ADR avec des fichiers texte ordinaires, vous voudrez peut-être définir votre propre convention de nommage des fichiers ADR.

Nous préférons une convention de nommage des fichiers qui suit un format précis.

Exemples :

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Notre convention de nommage des fichiers :

  • Le nom comporte une locution verbale à l’impératif présent. Cela facilite la lecture et correspond à notre format de messages de commit.

  • Le nom utilise des minuscules et des tirets (comme ce dépôt). C’est un compromis entre lisibilité et facilité d’utilisation côté système.

  • L’extension est markdown. Cela peut être utile pour une mise en forme facile.