Architecture Decision Record

Active theme: Light

← έγγραφα

Συμβάσεις ονομασίας αρχείων ADR

Αν επιλέξετε να δημιουργείτε τα ADR σας σε τυπικά αρχεία κειμένου, ίσως θέλετε να διαμορφώσετε τη δική σας σύμβαση ονομασίας αρχείων ADR.

Εμείς προτιμούμε μια σύμβαση ονομασίας αρχείων με συγκεκριμένη μορφή.

Παραδείγματα:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Η σύμβαση ονομασίας αρχείων που ακολουθούμε:

  • Το όνομα περιέχει μια ρηματική φράση σε προστακτική (στα αγγλικά, ενεστώτας). Αυτό βελτιώνει την αναγνωσιμότητα και ταιριάζει με τη μορφή των μηνυμάτων commit μας.

  • Το όνομα χρησιμοποιεί πεζά γράμματα και παύλες (όπως και αυτό το αποθετήριο). Είναι μια ισορροπία ανάμεσα στην αναγνωσιμότητα και τη χρηστικότητα στο σύστημα.

  • Η επέκταση είναι markdown. Αυτό διευκολύνει τη μορφοποίηση.