Anna agentille olennainen repositoriokonteksti
Tarjoa ajantasaiset ohjeet, tehtävään liittyvä koodi ja toimivat tarkistuskomennot ilman tarpeettomia tietoja.
Julkaisija TaigaNäin kirjoitamme
Mitä opit
- Kokoat tehtävään rajatun repositoriokontekstin.
- Tunnistat vanhentuneet ja ristiriitaiset ohjeet.
- Pidät tunnukset ja asiaan liittymättömät yksityiset tiedot kontekstin ulkopuolella.
Aloita nykyisestä checkoutista
Agentin pitää tietää, mitä repositoriota ja branchia se muuttaa. Sen pitää myös tunnistaa työskentelyhakemiston asiaan liittymättömät muutokset. Nämä tiedot vaikuttavat sallittuihin muokkauksiin ja lopullisen diffin tulkintaan.
Pyydä agenttia lukemaan projektin ohjeet ja package-konfiguraatio ennen toteutusta. Toisesta repositoriosta muistettu komento voi olla väärä. Tuttu framework ei kerro asennettua versiota tai projektin käytäntöjä.
Pieneen muutokseen riittävät usein kyseinen moduuli, sitä käyttävä koodi, testit ja olennainen arkkitehtuuripäätös. Lisää kontekstia, kun selvitys osoittaa siihen täsmällisen tarpeen.
Kirjaa pysyvät säännöt repositorioon
Ohjetiedosto voi kuvata tuetut komennot, moduulirajat, review-vaatimukset ja omistajan päätöstä tarvitsevat toimet. AGENTS.md-käytäntö antaa coding-työkaluille tunnistettavan paikan näille tiedoille. Työkalujen tuki ja ohjeiden etusijajärjestys voivat vaihdella, joten tarkista käyttämäsi työkalun toiminta.
Pidä pysyvät projektisäännöt repositoriossa ja nykyinen tehtävä tehtävänannossa. Ohjetiedostosta ei pidä tehdä jokaisen keskustelun historiaa tai väliaikaisten suunnitelmien listaa.
Hyödyllinen ohje on: ”Aja authorization-integraatiotestit, kun route muuttaa käyttöoikeuksia.” Epämääräinen ohje on: ”Ole aina tarkka tietoturvan kanssa.” Ensimmäinen kertoo tilanteen ja toimenpiteen, jonka tarkastaja voi todentaa.
Vertaa ohjetta koodiin
Ohjeet vanhenevat, kun komennot, hakemistot tai arkkitehtuuri muuttuvat. Jos ohje nimeää puuttuvan skriptin, tarkasta package-konfiguraatio. Jos dokumentti väittää palvelua vain lukevaksi, tarkasta käyttöoikeudet ennen väitteeseen luottamista.
Kirjaa ristiriita. Nykyisen version suora näyttö auttaa ymmärtämään toteutusta. Älä kuitenkaan hylkää tarkoituksellista sääntöä vain siksi, että vanha koodi rikkoo sitä. Sääntö ja nykyinen toiminta vastaavat eri kysymyksiin.
Ohje voi esimerkiksi kieltää suorat kirjoitukset yhteiseen branchiin, vaikka vanha skripti tekee niitä edelleen. Säilytä silloin sääntö ja korjaa skripti. Olemassa oleva koodi ei valtuuta toistamaan kiellettyä toimenpidettä.
Rajaa tiedot tehtävään
Repositoriossa voi olla tunnuksia, yksityisiä testiaineistoja, asiakasvientejä ja vanhoja tukilokeja. Pääsy repositorioon ei tee jokaisesta tiedostosta sopivaa kielimallipalvelun syötettä.
Käytä hyväksyttyjä työkaluja ja tietojen käsittelysääntöjä. Jätä salaisuudet pois kontekstista. Korvaa asiakasesimerkit mahdollisuuksien mukaan keksityllä datalla. Tarkasta liitetyt työkalutkin: hakuliitin voi tuoda tietoa, jota alkuperäisessä promptissa ei ollut.
Ohje ”älä lue salaisuuksia” auttaa. Se ei korvaa salaisuuksien säilytyspaikkojen ja arkaluonteisten hakemistojen käyttöoikeusrajoja.
Jätä seuraavalle tekijälle hyödyllinen jälki
Kirjaa pull requestiin muuttunut toiminta, tarkistukset ja avoimet rajoitukset. Päivitä pysyvä dokumentaatio, jos tuettu työnkulku muuttuu. Koko agenttikeskustelua ei tarvitse kopioida repositorioon.
Tulevan ylläpitäjän pitäisi pystyä toistamaan työ ilman pitkän keskustelun rekonstruointia. Linkitä kanonisiin dokumentteihin ja säilytä kustakin pysyvästä säännöstä yksi ensisijainen kuvaus.
Hyvä konteksti vähentää toistuvaa selvitystyötä. Se myös auttaa havaitsemaan virheitä, koska odotettu toiminta ja toimivat komennot on kirjattu.
Sovella käytäntöön
Tarkasta yhden repositorion ohjetiedosto. Varmista kolme komentoa nykyisestä projektista. Etsi yksi vanhentunut kohta tai puuttuva reunaehto. Ehdota pieni korjaus normaalin review-prosessin kautta. Älä lisää tunnuksia tai asiakastietoja.
Lataa työpohja (Markdown)Testaa, mitä opit
Lähteet ja lisälukeminen
Aiheesta Taigan sivuilla
Valinnan poistaminen poistaa kaikki tälle selaimelle tallennetut suoritusmerkinnät.
Edistyminen tallentuu tähän selaimeen. Ei käyttäjätiliä eikä seurantaa.