Suteikite agentui naudingą kodo saugyklos kontekstą

Pradėkite nuo dabartinės darbinės kopijos

Agentas turi žinoti, kurią kodo saugyklą ir šaką keičia. Jis taip pat turi žinoti, ar darbiniame kataloge yra nesusijusių pakeitimų. Šie faktai lemia, ką galima saugiai keisti ir kaip vertinti galutinį diff.

Paprašykite agento prieš įgyvendinimą išnagrinėti projekto instrukcijas ir paketo konfigūraciją. Iš kitos kodo saugyklos prisiminta komanda čia gali netikti. Pažįstamas karkaso pavadinimas neįrodo įdiegtos versijos ar projekto taisyklių.

Nedideliam pakeitimui pateikite susijusį modulį, jį kviečiantį kodą, testus ir architektūros sprendimą. Pridėkite daugiau informacijos, kai tyrimas parodo konkretų poreikį.

Kodo saugyklos instrukcijose laikykite pastovias taisykles

Instrukcijų failas gali aprašyti palaikomas komandas, modulių ribas, peržiūros reikalavimus ir veiksmus, kuriems reikia atsakingo asmens sprendimo. AGENTS.md susitarimas suteikia programavimo įrankiams atpažįstamą vietą šiai informacijai. Įrankių palaikymas ir instrukcijų prioritetai gali skirtis, todėl patikrinkite savo įrankio veikimą.

Pastovias projekto taisykles laikykite kodo saugykloje. Dabartinę užduotį laikykite užduoties apraše. Nepaverskite instrukcijų failo visų pokalbių istorija ar laikinų planų sąrašu.

Naudinga instrukcija sako: „Paleiskite autorizavimo integracinius testus, kai maršrutas pakeičia prieigos veikimą.“ Miglota instrukcija sako: „Visada atsargiai elkitės su saugumu.“ Pirmoji nurodo sąlygą ir veiksmą, kuriuos peržiūrėtojas gali patikrinti.

Patikrinkite instrukcijas pagal kodą

Instrukcijos pasensta pasikeitus komandoms, katalogams ar architektūrai. Jei vadove įvardytas neegzistuojantis scenarijus, išnagrinėkite paketo konfigūraciją. Jei dokumentas teigia, kad paslauga skirta tik skaityti, prieš pasitikėdami tuo patikrinkite teises.

Užfiksuokite prieštaravimą. Dabartiniam veikimui suprasti naudokite tiesioginius dabartinės versijos įrodymus. Tyliai neatmeskite sąmoningai nustatytos taisyklės vien todėl, kad senas kodas ją pažeidžia. Taisyklė ir dabartinis veikimas atsako į skirtingus klausimus.

Pavyzdžiui, vadovas gali drausti tiesiogiai rašyti į bendrą šaką, nors senas scenarijus vis dar tai daro. Teisinga reakcija yra išlaikyti taisyklę ir pataisyti scenarijų. Esamas kodas nesuteikia leidimo kartoti draudžiamo veiksmo.

Išlaikykite kontekstą aktualų ir saugų

Visoje kodo saugykloje gali būti prisijungimo duomenų, privačių testinių įrašų, klientų eksportų ir senų pagalbos žurnalų. Prieiga prie saugyklos savaime nereiškia, kad kiekvieną failą tinkama pateikti modelio paslaugai.

Naudokite patvirtintus įrankius ir duomenų tvarkymo taisykles. Neįtraukite paslapčių į kontekstą. Kur įmanoma, klientų pavyzdžius pakeiskite išgalvotais duomenimis. Patikrinkite ir prijungtus įrankius, ne tik įkeltus failus: paieškos jungtis gali gauti informacijos, kurios pradinėje užklausoje niekada nebuvo.

Kodo saugyklos instrukcija „neskaityti paslapčių“ yra naudinga gairė. Ji nepakeičia prieigos prie paslapčių saugyklos ir jautrių katalogų ribojimo.

Palikite kitam žmogui naudingą įrašą

Baigę darbą, pull request užfiksuokite pasikeitusį veikimą, patikrinimą ir neišspręstus apribojimus. Atnaujinkite ilgalaikę projekto dokumentaciją, kai keičiasi palaikoma darbo eiga. Nekopijuokite viso agento pokalbio į kodo saugyklą.

Įrašas turi padėti būsimam prižiūrėtojui pakartoti darbą neatkuriant ilgo pokalbio. Pateikite nuorodas į pagrindinius dokumentus ir laikykite vieną oficialų kiekvienos pastovios taisyklės aprašymą.

Geras kontekstas sumažina pakartotinį tyrimą. Jis taip pat padeda aptikti klaidas, nes numatytas veikimas ir veikiančios komandos nurodyti aiškiai.