Architecture Decision Record

Active theme: Light

← dokumen

Konvensyen nama fail untuk ADR

Jika anda memilih untuk mencipta ADR menggunakan fail teks biasa, anda mungkin mahu mencipta konvensyen nama fail ADR anda sendiri.

Kami lebih suka menggunakan konvensyen nama fail yang mempunyai format tertentu.

Contoh:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Konvensyen nama fail kami:

  • Nama mengandungi frasa kata kerja imperatif kala kini. Ini membantu kebolehbacaan dan sepadan dengan format mesej commit kami.

  • Nama menggunakan huruf kecil dan sengkang (sama seperti repositori ini). Ini ialah keseimbangan antara kebolehbacaan dan kebolehgunaan sistem.

  • Sambungan ialah markdown. Ini boleh berguna untuk pemformatan yang mudah.