Architecture Decision Record

Active theme: Light

← وثائق

اصطلاحات تسمية الملفات

إذا اخترت إنشاء سجلات ADR باستخدام ملفات نصية عادية، فقد ترغب في وضع اصطلاحك الخاص لتسمية ملفات ADR.

نفضّل اصطلاحًا لتسمية الملفات له صيغة محددة.

أمثلة:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

اصطلاحنا في تسمية الملفات:

  • يتضمن الاسم عبارة فعلية بصيغة الأمر في زمن المضارع. هذا يحسّن قابلية القراءة ويتوافق مع صيغة رسائل الإيداع (commit) لدينا.

  • يستخدم الاسم الأحرف الصغيرة والشرطات (مثل هذا المستودع). وهذا توازن بين قابلية القراءة وسهولة الاستخدام في النظام.

  • الامتداد هو markdown. وقد يفيد هذا في تنسيق سهل.