tickgit یک ابزار خط فرمان و برنامه وب است که به توسعه دهندگان کمک می کند تا از طریق استفاده از نظرات TODO و سایر نشانگرهای متن ساده ، مدیریت پروژه را در کد خود انجام دهند. این یک روش کم هزینه برای مدیریت موارد پشتیبان شما بدون تغییر متن است.
tickgit کد منبع را برای نشانگرهای TODO (و HACK ، FIXME ، XXX و غیره) اسکن می کند و این نظرات کد را به عنوان بلیط ، با متن کامل تر ناشی از تاریخچه Git (چه کسی آن را اضافه کرده است ، کی ، کجا و غیره) ارائه می دهد.
من یک ساختمان سازنده انفرادی هستم تیکیت و tickgit.com برای کمک به مهندسان نرم افزار در تولید کدشان بیشتر است. امیدوارم این پروژه برای شما جالب و مفید واقع شده باشد!
این مقاله بخشی از است نقشه راه، جایی که ما از نظر توسعه دهنده به تولید و تبلیغ محصولات نگاه می کنیم. ما دروس برتر رهبران محصولات را به اشتراک خواهیم گذاشت و به بنیانگذاران فنی فضایی خواهیم داد تا محصولات اولیه خود را با شما به اشتراک بگذارند. اگر شما علاقه مند به برجسته شدن هستید ، به ما اطلاع دهید.
چرا؟
مدیریت پروژه حتی برای توسعه دهندگان انفرادی که یک پروژه جانبی می سازند ، بخشی اساسی در توسعه نرم افزار است. بسیاری از سیستم های موجود در زمینه فروش بلیط و مدیریت وظایف به تیم ها و افراد کمک می کند تا کارهای معلق را کاملاً دقیق پیگیری کنند. هر چند گاهی با استفاده از نظرات TODO و نشانگرهای دیگر در داخل در پایان یک codebase راهی کارآمدتر برای نگه داشتن برگه هایی است که باید انجام شود.
نظرات TODO (یا FIXME ، HACK ، OPTIMIZE ، XXX و غیره) روشی متداول است که توسعه دهندگان نشان می دهند یک منطقه از کد ارزش آدرس دهی و بازگشت به آن را دارد. پایگاه کد لینوکس 4K+ از این نوع نظرات دارد ، فرمانداران 2k + دارد.
اگر این یک نوع چیز منظره آشنایی است ، بدون شک قبلاً آنها را دیده یا استفاده کرده اید:
// TODO: Get rid of this condition somehow. Perhaps with a dynamic version
// of the @gate pragma.
TODO ها آسان هستند
اضافه کردن و حذف کارها آسان است. نیازی نیست ویرایشگر خود را ترک کنید. آنها متن ساده ای هستند. می توانید پیوندهایی را برای اطلاعات اضافی درج کنید. انعطاف پذیر هستند حتی می توانید از شکلک استفاده کنید. شما محدود به شرایط مربوط به سیستم بلیط خارجی نیستید. می توانید در توصیف اینکه چرا یک منطقه از کد را حاشیه نویسی می کنید ، دقیق و مختصر باشید.
بدون تغییر زمینه
کارها درست در کنار کدی است که آنها توصیف می کنند ، به این معنی که شما زمینه پایگاه کد را از دست نمی دهید: کلاسهای اطراف ، توابع ، متغیرها و غیره. با استفاده از یک سیستم فروش بلیط خارجی ، هنگام تلاش باید تمرکز را تغییر دهید برای درک بلیط و کد مربوطه ، یا کپی برداری متن زیادی را انجام دهید تا به شما کمک کند تا وظیفه خود را روشن کنید.
انجام کارها به شما امکان می دهد هنگام نوشتن کد ، جریان خود را حفظ کنید و معمولاً بار روانی کمتری نسبت به ورود و برگشت به بلیط در یک سیستم خارجی دارد. البته انجام کارها در صورت لزوم می تواند برای کسب اطلاعات بیشتر به یک بلیط موجود پیوند دهد.
با کد شما قابل پیگیری است
از آنجا که نظرات TODO بخشی از کد شما هستند ، در کنترل نسخه ذخیره می شوند. آنها می توانند در روابط عمومی شما تحت بازنگری کد قرار بگیرند. آنها دارای سابقه هستند و می توان آنها را به نویسندگان ، نسخه ها و تعهدات نسبت داد. این می تواند گزارش های آگاهانه مدیریت پروژه را در مورد محل سکونت ، مسئولیت های تیم ، بدهی های فنی ، کارایی توسعه و غیره فعال کند
تیکیت ابزار خط فرمان یک پروژه منبع باز است که یک پایگاه کد Git را برای نظرات TODO اسکن می کند. این یک سرزنش Git را اجرا می کند و نتایج را با مراجعه به مسیرهای پرونده و شماره های خط تولید می کند.
می تواند برای پرس و جو موقت برای نظرات TODO باز مورد استفاده قرار گیرد و از خروجی CSV برای مصرف توسط ابزارهای دیگر (صفحات گسترده ، پردازشگرهای متن و غیره) پشتیبانی می کند.
در اینجا یک مثال خروجی آورده شده است:
CLI در حال حاضر بسیار ساده است ، اما با برنامه ریزی هایی برای بهبود موارد استفاده بیشتر ، از جمله:
- سفارشی سازی عبارات برای مطابقت (با XXX مطابقت ندارد اما مطابقت دارد)
@TODOدر نظرات) - پرس و جو و فیلتر کردن (تمام موارد اضافه شده در این هفته را به من نشان دهید ، فقط مال من را نشان دهید و غیره)
- نمایش داده شد تجمع توسط نویسنده ، میانگین سنی توسط نویسنده ، و غیره
- حالت CI در صورت رعایت معیارهای خاص با خطا از کار می افتد (عدم اجازه کار در شاخه های خاص ، حداکثر 5 بار برای هر نویسنده و غیره)
- استخراج پیوندها و تجزیه و تحلیل سفارشی نظرات (استخراج یک منتخب ، موعد مقرر و غیره)
tickgit.com
برنامه وب tickgit SaaS است که در حال حاضر با GitHub ادغام می شود. استفاده از آن برای مخازن عمومی رایگان است (نیازی به ثبت نام نیست). می توانید نظرات TODO باز ، و برخی از آمار خلاصه از جمله نمودارهای شمارش توسط نویسنده و میانگین سنی توسط نویسنده را مشاهده کنید.
هر نظر TODO به عنوان یک کارت ارائه می شود ، که اطلاعات مشابه CLI را نشان می دهد. با کلیک کردن ، به پرونده و خط نظر TODO در UI GitHub خواهید رسید.
مخازن خصوصی با هزینه 3 دلار در ماه (برای افراد) پشتیبانی می شوند. تمام ویژگی های نسخه رایگان (برای repos های عمومی) در نسخه های پرداخت شده برای repos های خصوصی وجود دارد.
برخی از پیشرفت هایی که در راه است شامل موارد زیر است:
- در نظرات TODO مخزن به عنوان خلاصه ایمیل هفتگی مشترک شوید
- پرس و جو و فیلتراسیون بهبود یافته (کارهای روزمره ، کارهای انجام شده قدیمی تر از تاریخ و غیره را پیدا کنید)
- پشتیبانی از میزبان های بیشتر Git (GitLab ، BitBucket ، sourcehut و غیره)
- ادغام بهتر با ابزارهای شخص ثالث مانند Trello ، Jira و Slack
سر به tickgit.com و آن را برای چرخش در یکی از repos عمومی خود بگیرید. امیدوارم تعجب کنید که با چه کارایی بیشتری می توانید از پس زمینه ای که حتی نمی دانید دارید کار کنید!
