خبرهای تکنولوژی رو از دست ندید. 
در دنیای توسعه نرم‌افزار، کد ریویو یکی از مهم‌ترین مراحل برای اطمینان از کیفیت کد هست. اما اغلب اوقات، ابزارهایی مثل گیتهاب باعث می‌شن این فرآیند کند و خسته‌کننده بشه. اگر شما هم مثل من، ساعت‌ها رو صرف باز کردن مرورگر، لود شدن دیف‌ها و نوشتن کامنت‌های آنلاین کردید، بدونید که تنها نیستید! در این پست، می‌خوام در مورد یک روش جالب به نام git-review حرف بزنم که کد ریویو رو محلی و بر پایه گیته انجام می‌ده. این روش رو از مقاله‌ای در بلاگ TigerBeetle الهام گرفتم و می‌خوام ساده توضیح بدم چطور کار می‌کنه، مزایاش چیه و چرا ممکنه برای تیم شما مفید باشه. اگر به بهبود فرآیند کد ریویو علاقه‌مندید، ادامه بدید!
مشکلات کد ریویو سنتی: چرا گیتهاب کافی نیست؟
قبل از اینکه سراغ روش جدید بریم، بیایم ببینیم چرا روش‌های فعلی دردسر دارن. در ابزارهایی مثل گیتهاب یا بیت‌باکت، دو مشکل اصلی وجود داره:
- عدم ذخیره‌سازی محلی حالت ریویو: همه کامنت‌ها و تغییرات در دیتابیس خارجی ذخیره می‌شن. اگر سرویس قطع بشه یا بخواید به ریپو مهاجرت کنید، همه تاریخچه ریویو از دست می‌ره.
- رابط وب کند و غیرکارآمد: ریویو کردن از طریق مرورگر یعنی منتظر لود شدن صفحه‌ها بودن، کلیک‌های بی‌پایان و عدم دسترسی به ابزارهای محلی مثل ادیتور کد. مثلاً، نمی‌تونید مستقیم تست‌ها رو اجرا کنید یا به تعریف توابع برید بدون اینکه مرورگر رو باز کنید.
من خودم بارها تجربه کردم: کد رو محلی کلون می‌کنم، با ابزارهایی مثل Magit در ایمکس دیف‌ها رو چک می‌کنم، اما برای نوشتن کامنت باید برم تو گیتهاب و منتظر HTTP درخواست‌ها بمونم. این کار نه تنها زمان‌بره، بلکه خلاقیت رو هم می‌کشه!
git-review چیست؟ روشی محلی برای کد ریویو بهتر
حالا برسیم به اصل مطلب: git-review یک ابزار ساده و هک‌مانند هست که کد ریویو رو به عنوان بخشی از گیته محلی تبدیل می‌کنه. ایده اصلی اینه که ریویو رو مثل یک کامیت روی شاخه PR ذخیره کنید، نه در یک وب‌سایت خارجی. این روش حدود ۵۰۰ خط کد داره و برای تیم‌های کوچک عالیه. بیایم گام‌به‌گام ببینیم چطور کار می‌کنه:
- شروع ریویو: وقتی یک PR باز می‌شه، ریویور کد رو محلی کلون می‌کنه و یک کامیت جدید روی شاخه PR می‌سازه. این کامیت شامل کامنت‌های کد برای فیدبک‌هاست.
- نوشتن فیدبک به عنوان کامنت کد: به جای نوشتن در وب، کامنت‌ها رو مستقیم در کد اضافه می‌کنید. مثلاً: text
// CR(نام_ریویور): این چک به نظرم دقیق نیست. نباید replica.view رو مقایسه کنیم به جای header.view؟این کامنت‌ها با علامت‌های خاص مثل // CR یا //? resolved مشخص می‌شن تا راحت جستجو بشن. - به‌روزرسانی و تعامل: نویسنده کد و ریویور این کامیت رو ویرایش می‌کنن. از دستورهایی مثل git push –force-with-lease استفاده می‌کنید تا تغییرات بدون از دست دادن کار دیگران اعمال بشه.
- پایان ریویو: وقتی همه threadها resolve شدن (با علامت //? resolved)، یک کامیت revert اضافه می‌کنید تا تاریخچه ریویو در گیته حفظ بشه. حالا می‌تونید مرج کنید!
این روش ساده به نظر می‌رسه، اما قدرت اصلیش در محلی بودنشه. می‌تونید از ادیتور خودتون استفاده کنید، تست‌ها رو اجرا کنید و حتی refactoring پیشنهاد بدید بدون خروج از محیط محلی.
مزایای استفاده از git-review در تیم‌های توسعه
چرا این روش می‌تونه کد ریویو بهتر بسازه؟ بیایم مزایا رو لیست کنیم:
- سرعت بالاتر: بدون لگ وب، همه چیز محلی اجرا می‌شه. ادیتور کدتون (مثل VS Code یا Vim) همه ابزارها رو داره، از جمله تکمیل کد و ناوبری.
- حفظ تاریخچه در ریپو: ریویو بخشی از گیته می‌شه، پس vendor lock-in ندارید و می‌تونید به راحتی مهاجرت کنید.
- تعامل طبیعی‌تر: کامنت‌ها مثل کد نوشته می‌شن، پس راحت‌تر می‌تونید پیشنهاد تغییرات بدید و حتی کد نمونه اضافه کنید.
- مناسب برای تیم‌های توزیع‌شده: چون بر پایه گیته، همه می‌تونن محلی کار کنن و فقط push/pull کنن.
در مقاله TigerBeetle، نویسنده می‌گه این روش اجازه می‌ده “کد رو ریویو کنید نه فقط دیف” – یعنی می‌تونید تست‌ها رو اجرا کنید و زمینه رو ببینید، که در وب ممکن نیست.
چالش‌ها و محدودیت‌های git-review
البته هیچ روشی کامل نیست. نویسنده مقاله اعتراف می‌کنه که git-review در نهایت کنار گذاشته شد چون:
- کنفلیکت‌های مرج: اگر کد اصلی تغییر کنه، کامنت‌های ریویو ممکنه با مشکل مواجه بشن.
- پیچیدگی force push: استفاده از –force-with-lease گاهی دردسر داره و نیاز به دقت بالا داره.
اگر تیم بزرگی دارید، ممکنه این روش شلوغ بشه. اما برای پروژه‌های کوچک یا آزمایش، عالیه. پیشنهاد می‌کنم با ابزارهای مشابه مثل git-appraise یا git-bug هم آشنا بشید.
نتیجه‌گیری: آیا git-review برای شما مناسبه؟
اگر از کد ریویو سنتی خسته شدید و می‌خواید یک روش محلی و قدرتمند امتحان کنید، git-review گزینه خوبیه. این روش نشون می‌ده که با کمی خلاقیت، می‌تونیم فرآیندهای قدیمی رو بهبود بدیم. من خودم دارم امتحانش می‌کنم و نتایجش رو در پست‌های بعدی به اشتراک می‌ذارم. شما چی؟ تجربه‌ای از بهبود کد ریویو دارید؟ در کامنت‌ها بنویسید!
سلام! من میثم ایلکا هستم، یه عاشق دنیای هوش مصنوعی و تکنولوژی! چندین ساله که تو این حوزه فعالیت دارم، تحقیق و مطالعه می‌کنم و همیشه دنبال کشف چیزای جدیدم. از یادگیری ماشین و پردازش تصویر و مدل های زبانی بزرگ گرفته تا آینده‌ی هوش مصنوعی و تأثیرش روی زندگی ما، همه اینا برام جذابن.
0 دیدگاه‌ها