شاهین

قرارداد نام‌گذاری رویداد

متوسط
به‌روزرسانی ۲۰ تیر ۱۴۰۵ تحریریه شاهین ۲ دقیقه مطالعه
تلفظEN/ɪˈvɛnt ˈneɪmɪŋ kənˈvɛnʃən/

قرارداد نام‌گذاری رویداد قاعده توافق‌شده‌ای است که تعیین می‌کند نام هر رویداد چطور ساخته شود تا فهرست رویدادها با رشد تعدادشان قابل پیش‌بینی بماند.

یک قرارداد کارآمد سه چیز را قفل می‌کند: شکل نوشتار مثل snake_case، ترتیب اجزا یعنی اول موضوع بعد اقدام (article_viewed نه viewed_article)، و زمان فعل که معمولا گذشته انتخاب می‌شود؛ کنار این سه، یک پیشوند هم برای رویدادهایی که خود پلتفرم می‌فرستد رزرو می‌شود. اهمیت این قاعده از آنجاست که نام، کلید اصلی کل مجموعه داده است و اصلاح نام‌های گذشته گران تمام می‌شود. خطای رایج این است که قرارداد فقط در یک سند بماند: بدون بررسی هنگام code review یا هشدار در خود ابزار، انحراف ظرف چند هفته شروع می‌شود. جزئیات ریز هم در نام جایی ندارد و نامی مثل checkout_button_blue_clicked باید یک رویداد با ویژگی رنگ باشد.

پرسش‌های پرتکرار