مخففهای چت
در چت تیم و زیر pull requestها کسی جملهی کامل تایپ نمیکند. این هشت مخفف را آنقدر میبینی که بهتر است همین امروز با آنها دوست شوی.
مخفف، اولِ جمله و با ویرگول
بیشتر این مخففها اول جمله میآیند و بعدشان یک ویرگول میگذارند: FYI, the server is down یا BTW, I fixed it. خود مخفف جای یک عبارت کامل نشسته است (by the way)، پس بقیهی جمله عادی نوشته میشود. یادت باشد اینها زبان چتاند: در ایمیل رسمی به مشتری، کاملش را بنویس.
هشت کلمهی این درس
LGTM (اِلجیتیاِم): به نظر من خوب است (تأیید کد)
چهار حرف اول جملهی Looks Good To Me است، یعنی «به نظر من خوب است». وقتی کسی کد تو را در یک pull request میخواند و ایرادی نمیبیند، همین چهار حرف را مینویسد. معنایش این است: خواندم، قبول دارم، میتوانی merge کنی.
LGTM, you can merge it after the tests pass.
به نظرم خوب است، بعد از اینکه تستها قبول شدند میتوانی merge کنی.
WIP (دابلیوآیپی): کارِ در حال انجام؛ هنوز تمام نشده
progress یعنی پیشرفت و in progress یعنی «در جریان». WIP یعنی کاری که شروع شده ولی هنوز تمام نیست. آن را اول عنوان یک pull request یا commit میگذارند تا بقیه بدانند: این را هنوز merge نکنید، فقط دارم نشان میدهم تا کجا رسیدهام.
This is still WIP, so please do not merge it yet.
این هنوز در حال انجام است، پس لطفاً فعلاً merge نکنید.
FYI (اِفوایآی): محض اطلاع؛ فقط خواستم بدانی
information یعنی اطلاع و خبر. FYI یعنی «برای اطلاع تو». وقتی خبری میدهی که طرف لازم نیست برایش کاری بکند یا جوابی بدهد، جمله را با FYI شروع میکنی. در چت تیم و ایمیل کاری خیلی زیاد میبینیاش.
FYI, the staging server will be down for an hour tonight.
محض اطلاع، سرور staging امشب یک ساعت خاموش است.
TL;DR (تیاِلدیآر): خلاصهی یکخطیِ یک متن بلند
جملهی کاملش یعنی «خیلی بلند بود؛ نخواندم». اولش جوابی شوخی به متنهای دراز بود، ولی امروز خود نویسنده آن را بالای متنش میگذارد و بعدش کل حرف را در یک یا دو خط میگوید. در README، توضیح pull request و پیامهای بلند چت، اگر وقت نداری اول سراغ TL;DR برو.
TL;DR: the bug was in the cache, and it is fixed now.
خلاصه: باگ در cache بود و حالا درست شده است.
ASAP (اِیسَپ): هر چه زودتر؛ در اولین فرصت
soon یعنی زود و possible یعنی ممکن. ASAP یعنی «هر قدر زود که ممکن است». وقتی کاری فوری است، مثلاً سایت خراب شده و کاربرها منتظرند، مینویسند fix it ASAP. کلمهی پرفشاری است؛ اگر برای هر کاری بنویسیاش، دیگر کسی جدیاش نمیگیرد.
Login is broken for everyone, we need a fix ASAP.
ورود برای همه خراب است، هر چه زودتر یک راهحل لازم داریم.
AFAIK (اِیاِفاِیآیکِی): تا جایی که من میدانم
far یعنی دور و as far as I know یعنی «تا آنجا که دانستهی من میرسد». وقتی جوابی میدهی ولی صددرصد مطمئن نیستی، آن را با AFAIK شروع میکنی. این یعنی: فکر میکنم همین است، ولی خودت هم یک نگاه بینداز. نشانهی دقت است، نه ضعف.
AFAIK, this function is not used anywhere in the project.
تا جایی که میدانم، این تابع هیچ جای پروژه استفاده نمیشود.
IMO (آیاِماُ): به نظر من
opinion یعنی نظر و عقیده. با IMO میگویی حرفی که میزنی نظر شخصی توست، نه یک قانون. در بازبینی کد خیلی به کار میآید، چون پیشنهادت را نرم میکند: نمیگویی «این غلط است»، میگویی «به نظر من آن یکی بهتر است».
IMO a simple loop is easier to read here.
به نظر من اینجا یک حلقهی ساده راحتتر خوانده میشود.
BTW (بیتیدابلیو): راستی؛ در ضمن
way یعنی راه و by the way یعنی «سرِ راه»، همان «راستی» خودمان. وقتی وسط یک حرف، چیز دیگری یادت میآید که به موضوع اصلی ربط کمی دارد، با BTW شروعش میکنی. در چت تیم برای خبرهای کوچکِ کناری است.
BTW, I also renamed the config file in this commit.
راستی، در همین commit اسم فایل تنظیمات را هم عوض کردم.
گفتوگو زیر یک pull request
Sara: FYI, I opened a new pull request for the profile page. It is still WIP, so please don't merge it yet.
Ali: Thanks! What is the TL;DR of the change?
Sara: The page loads only the data it needs, so it opens faster.
Ali: Nice. AFAIK the old code is also used on the settings page. Did you check that?
Sara: Good point. I will look at it ASAP.
Ali: BTW, IMO the new function names are much clearer.
(two hours later)
Ali: I read all of it. LGTM!
سارا: محض اطلاع، برای صفحهی پروفایل یک pull request تازه باز کردم. هنوز در حال انجام است، پس لطفاً فعلاً merge نکن.
علی: ممنون! خلاصهی تغییر چیست؟
سارا: صفحه فقط دادهای را که لازم دارد میگیرد، برای همین زودتر باز میشود.
علی: عالی. تا جایی که میدانم کد قدیمی در صفحهی تنظیمات هم استفاده میشود. آن را بررسی کردی؟
سارا: نکتهی خوبی بود. هر چه زودتر نگاهش میکنم.
علی: راستی، به نظر من اسمهای تازهی تابعها خیلی روشنترند.
(دو ساعت بعد)
علی: همهاش را خواندم. به نظرم خوب است!