مدیریت تغییرات توابع R با هوش مصنوعی
برای یک تابع یا ورودی قدیمی جایگزین معرفی کنید. متن راهنما، هشدار و تستها رو طوری آماده کنید که کسی که بسته رو بهروز میکنه بدونه چه تغییری لازمه.
مدیریت تغییرات توابع R با هوش مصنوعی وقتی به کارتون میاد که میخواید اسم یک ورودی رو عوض کنید، ولی هنوز آدمهایی هستن که با اسم قبلی کد مینویسن. اگر اسم قبلی یکدفعه از کار بیفته، ممکنه خطایی بگیرن که معلوم نیست برای رفعش باید کجای برنامهشون رو عوض کنن. مستندات و یک هشدار درست میتونن مسیر تغییر رو براشون روشن کنن.
اسکیل r-lifecycle با چند حالت مختلف سروکار داره. گاهی یک تابع هنوز کار میکنه و قراره همونطور بمونه، ولی برای کدهای جدید گزینه مناسبتری معرفی میکنید. گاهی هم تصمیم دارید تابع رو در آینده کنار بذارید. ایجنتتون بر اساس این تصمیم کمک میکنه رفتار تابع، توضیح صفحه راهنما و تستها با هم جور باشن.
کاربردها
- برای یک تابع قدیمی جایگزینی معرفی کنید که همون کار رو انجام بده.
- تغییر نام ورودی رو همراه با یک نمونه استفاده از نام جدید توضیح بدید.
- پیام هشدار رو برای کسی بنویسید که فقط موقع اجرای کد با تغییر روبهرو میشه.
- در راهنمای مهاجرت مشخص کنید چه چیزی هنوز کار میکنه و چه چیزی قراره حذف بشه.
- بررسی کنید تست هم نتیجه تابع و هم هشدار موردانتظار رو پوشش بده.
نصب و استفاده
- اسکیل رو به ایجنتتون اضافه کنید و یک پروژه R با دسترسی ویرایش در اختیارش بذارید. برای پیادهسازی به بسته lifecycle و برای راهاندازی اولیه به usethis نیاز دارید.
- مثلا بگید «در تابع خروجی گرفتن، اسم ورودی مسیر رو عوض کردیم. یک نمونه با اسم جدید، یک هشدار قابلفهم برای اسم قبلی و تست مربوطش رو آماده کنید.»
- هر دو شکل استفاده از تابع رو بررسی کنید. بعد متن راهنما رو مثل کسی بخونید که فقط با نسخه قبلی آشناست و ببینید قدم بعدی برای چنین کسی روشنه یا نه.
سوالات متداول
منبع
ساخته Garrick Aden-Buie. نام اصلی: r-lifecycle، منتشرشده در GitHub با مجوز MIT.
مشاهده در GitHub