Дайце агенту карысны кантэкст рэпазіторыя

Пачніце з бягучай рабочай копіі

Агент павінен ведаць, які рэпазіторый і галіну ён змяняе. Яму таксама трэба ведаць, ці ёсць у рабочым каталогу не звязаныя з задачай змены. Гэтыя факты ўплываюць на тое, што ён можа бяспечна рэдагаваць і як трэба тлумачыць канчатковы diff.

Папрасіце агента вывучыць інструкцыі праекта і канфігурацыю пакета перад рэалізацыяй. Запомненая каманда з іншага рэпазіторыя тут можа быць няправільнай. Знаёмая назва framework не пацвярджае ўсталяваную версію або правілы праекта.

Для невялікай змены перадайце адпаведны модуль, код, які яго выклікае, тэсты і архітэктурнае рашэнне. Дадавайце інфармацыю, калі даследаванне паказвае канкрэтную патрэбу.

Захоўвайце пастаянныя правілы ў інструкцыях рэпазіторыя

Файл інструкцый можа апісваць падтрыманыя каманды, межы модуляў, патрабаванні да праверкі і дзеянні, для якіх патрэбнае рашэнне адказнага. Канвенцыя AGENTS.md дае інструментам для кода пазнавальнае месца для гэтай інфармацыі. Падтрымка інструментамі і прыярытэт інструкцый могуць адрознівацца, таму правярайце паводзіны свайго інструмента.

Захоўвайце пастаянныя правілы праекта ў рэпазіторыі. Бягучую задачу трымайце ў заданні. Не ператварайце файл інструкцый у гісторыю кожнай размовы або спіс часовых планаў.

Карысная інструкцыя кажа: «Запускайце інтэграцыйныя тэсты аўтарызацыі, калі маршрут змяняе паводзіны доступу». Расплывістая інструкцыя кажа: «Заўсёды будзьце асцярожныя з бяспекай». Першая вызначае ўмову і дзеянне, якія рэцэнзент можа праверыць.

Звярайце інструкцыі з кодам

Інструкцыі старэюць, калі змяняюцца каманды, каталогі або архітэктура. Калі дапаможнік называе адсутны скрыпт, вывучыце канфігурацыю пакета. Калі дакумент кажа, што сэрвіс працуе толькі для чытання, праверце дазволы, перш чым абапірацца на гэтае сцверджанне.

Зафіксуйце супярэчнасць. Выкарыстоўвайце непасрэдныя доказы пра бягучую версію, каб зразумець паводзіны рэалізацыі. Не адкідайце моўчкі наўмысную палітыку толькі таму, што стары код яе парушае. Палітыка і бягучыя паводзіны адказваюць на розныя пытанні.

Напрыклад, дапаможнік можа забараняць непасрэдны запіс у агульную галіну, а стары скрыпт усё яшчэ яго выконвае. Правільнае дзеянне — захаваць палітыку і выправіць скрыпт. Наяўны код не дае дазволу паўтараць забароненае дзеянне.

Захоўвайце кантэкст адпаведным задачы і бяспечным

Увесь рэпазіторый можа змяшчаць уліковыя даныя, прыватныя тэставыя даныя, экспартаваныя даныя кліентаў і старыя журналы падтрымкі. Доступ да рэпазіторыя не робіць кожны файл аўтаматычна прыдатным для сэрвісу мадэлі.

Выкарыстоўвайце ўхваленыя інструменты і правілы апрацоўкі даных. Выключайце сакрэты з кантэксту. Па магчымасці замяняйце прыклады кліентаў выдуманымі данымі. Правярайце падключаныя інструменты, а не толькі загружаныя файлы: пошукавы канектар можа атрымаць інфармацыю, якой ніколі не было ў пачатковым запыце.

Інструкцыя рэпазіторыя «не чытайце сакрэты» карысная. Яна не замяняе абмежавання доступу да сховішча сакрэтаў і каталогаў з канфідэнцыяльнымі данымі.

Пакіньце карысны запіс наступнаму чалавеку

Пасля завяршэння запішыце ў pull request змененыя паводзіны, праверку і нявырашаныя абмежаванні. Абнаўляйце доўгатэрміновую дакументацыю праекта, калі змяняецца падтрыманы працоўны працэс. Не капіруйце ўсю перапіску агента ў рэпазіторый.

Запіс павінен дапамагчы будучаму спецыялісту па суправаджэнні паўтарыць працу без аднаўлення доўгай размовы. Спасылайцеся на кананічныя дакументы і захоўвайце адно аўтарытэтнае апісанне кожнага пастаяннага правіла.

Добры кантэкст памяншае паўторныя даследаванні. Ён таксама палягчае выяўленне памылак, бо чаканыя паводзіны і працоўныя каманды зададзены яўна.