Katika ulimwengu wa ukuzaji programu, kila msanidi anafahamu maoni ya kuaminika TODO
. Mara nyingi hutumika kama kikumbusho cha haraka kutazama upya msimbo, kirekebishaji upya, au kukamilisha kazi baadaye. Lakini baada ya muda, maoni haya TODO
yanaweza kulundikana, na kuwa milundikano ya kimya cha deni la kiufundi - mzigo uliofichwa ambao unaweza kuathiri afya na udumishaji wa mradi.
Ikiachwa bila kuangaliwa, vikumbusho hivi vilivyotawanyika vinaweza kupunguza msimbo, hivyo kufanya iwe vigumu kwa wasanidi programu kusogeza, kutatua na kupanua. Katika kazi yangu mwenyewe, nilikumbana na suala hili moja kwa moja na hatimaye nikaamua kulishughulikia kwa chombo kinachofanya deni la kiufundi lionekane na liweze kutekelezwa: Todoctor .
TODO
Mara ya kwanza, maoni TODO
yanaweza kuonekana kuwa yasiyodhuru au hata kusaidia. Ni ishara kwa wasanidi programu kutazama upya jambo fulani - labda kuboresha kanuni, kurekebisha sehemu ya hila, kuchukua nafasi ya utegemezi uliopitwa na wakati, au kukamilisha kipengele ambacho bado kinaendelea. Hata hivyo, kukiwa na ratiba zenye shughuli nyingi, kubadilisha vipaumbele, na makataa mafupi, TODO
hizi mara nyingi huahirishwa kwa muda usiojulikana. Badala ya kushughulikiwa, yanakuwa mabaki ya vitu vilivyoachwa bila kutatuliwa.
Baada ya muda, maoni TODO
yanaweza kuunda masuala kadhaa:
TODO
unatoa udanganyifu kwamba msimbo umetunzwa vyema, ilhali, kwa kweli, huficha kazi zisizokamilika na masuala ambayo hayajatatuliwa.TODO
, hasa wakati washiriki wa timu huja na kuondoka. Hii inasababisha kuongezeka kwa kukatwa kati ya kanuni na uelewa wa timu kuihusu. Katika miradi mikubwa au iliyo na wachangiaji wengi, shida inakua tu. Bila uangalizi wa mara kwa mara, TODO
s inaweza kutawanywa katika codebase, hivyo kufanya kuwa changamoto ya kusimamia na kufuatilia madeni ya kiufundi.
Nilipokuwa nikikabiliana na tatizo hili, nilitambua hitaji la zana ya kuleta maoni TODO
nje ya maficho na katika nafasi inayoweza kutekelezeka ambapo timu zinaweza kuyatathmini na kuyashughulikia kwa urahisi. Hii ilisababisha kuundwa kwa Todoctor , shirika la CLI lililoundwa kuchambua na kufuatilia maoni TODO
katika JavaScript na TypeScript codebases.
Wakiwa na Todoctor, wasanidi programu na timu wanaweza kuibua na kudhibiti deni lao la kiufundi kwa wakati, kuwasaidia kufanya maamuzi sahihi kuhusu kuweka kipaumbele kwa usafishaji na urekebishaji upya. Hivi ndivyo inavyofanya kazi:
TODO
: Todoctor huchanganua codebase ili kupata kila maoni TODO
, kukusanya taarifa kuhusu umri wa kila maoni, mwandishi na maudhui.TODO
imebadilika kwa wakati, na kuzipa timu picha wazi ya deni lao la kiufundi.TODO
, kuona ni nani aliyeiunda, na kuona orodha inayoweza kupangwa ya kazi zote zinazosubiri katika msingi wa msimbo.
Kupitia vipimo hivi, Todoctor anageuza deni la kiufundi kuwa kipengele kinachoonekana, kinachoweza kudhibitiwa cha mradi. Uwazi huu unaweza kuhamasisha timu kuchukua hatua kuhusu majukumu ambayo hayajakamilika, na husaidia kukuza utamaduni wa umiliki na ubora wa kanuni.
Todoctor ilitengenezwa kwa unyenyekevu na utumiaji akilini, ikiiruhusu kuunganishwa bila mshono katika mtiririko wowote wa maendeleo. Chombo kimeandikwa katika JavaScript na hufanya kazi kama matumizi ya CLI, ambayo hurahisisha kusanidi na kuendesha kwa amri moja.
Kwa kila maoni TODO
, Todoctor hukusanya metadata kama vile:
Umri wa Maoni : Muda gani TODO
imekuwa kwenye msingi wa msimbo.
Jumla ya Idadi ya TODO
s: Hesabu moja kwa moja ili kufuatilia ukubwa wa deni.
Wastani wa Umri wa TODO
s: Muhtasari wa muda wa kazi zinazosubiri.
Wachangiaji Maarufu : Orodha inayoonyesha ni washiriki wa timu gani waliandika TODO
nyingi zaidi, ikiruhusu timu kufuatilia kazi mahususi.
Kwa kutumia data hii, Todoctor hutoa ripoti ya kina ya HTML ambayo inaweza kuongezwa kwenye msingi wa kanuni au kushirikiwa na timu.
Kuanza kutumia Todoctor, isakinishe tu na endesha amri ifuatayo kwenye mzizi wa mradi wako:
npx todoctor
Ndani ya sekunde chache, Todoctor atachanganua codebase yako na kutoa ripoti, kukupa mtazamo kamili wa deni lako la kiufundi na maarifa yanayoweza kutekelezeka.
Deni la kiufundi linaweza kuonekana kama suala dogo hadi litakapoanza kupunguza kasi ya maendeleo na kuathiri ubora wa msimbo. Maoni ya TODO
, ingawa yanafaa kwa muda mfupi, yanaweza kusahaulika kwa urahisi ambayo yanahitaji kushughulikiwa. Kwa kufanya vikumbusho hivi vionekane na kupimika, Todoctor huzipa timu uwezo wa kuchukua tena udhibiti wa msingi wao wa kanuni, kuhakikisha kuwa inadumishwa na iko tayari kwa ukuaji wa siku zijazo.
Jaribu Todoctor :