Architecture Decision Record

Active theme: Light

← מסמכים

מוסכמות שמות קבצים ל-ADR

אם אתם בוחרים ליצור את ה-ADR שלכם בקובצי טקסט רגילים, ייתכן שתרצו לקבוע מוסכמת שמות קבצים משלכם ל-ADR.

אנחנו מעדיפים מוסכמת שמות קבצים בעלת פורמט מסוים.

דוגמאות:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

מוסכמת שמות הקבצים שלנו:

  • השם כולל ביטוי פועלי בציווי בהווה. זה משפר את הקריאות ותואם את פורמט הודעות ה-commit שלנו.

  • השם משתמש באותיות קטנות ובמקפים (כמו במאגר הזה). זה איזון בין קריאות לשימושיות במערכת.

  • הסיומת היא markdown. זה יכול להיות שימושי לעיצוב קל.