Път 02Урок 2 / 6

Дайте на агента полезен контекст за хранилището

Предоставете актуални инструкции, подходящ код и работещи команди за проверка, без да разкривате ненужна информация.

Практическо ниво9 минПрегледано

Публикувано от Как пишем

Проверете разбирането сиРъководството на хранилището препоръчва команда, която вече не съществува. Какво трябва да направи агентът?Направете упражнението
Ръководството на хранилището препоръчва команда, която вече не съществува. Какво трябва да направи агентът?

Какво ще научите

  • Подгответе целеви набор от контекст за задача в хранилището.
  • Определете остарели или противоречиви инструкции.
  • Пазете данните за удостоверяване и несвързаните частни данни извън контекста на задачата.

Започнете с текущото работно копие

Агентът трябва да знае кое хранилище и кой клон променя. Трябва да знае и дали работната директория съдържа несвързани промени. Тези факти влияят върху това какво може безопасно да редактира и как да се тълкува крайният diff.

Поискайте агентът да прегледа инструкциите на проекта и конфигурацията на пакетите преди реализацията. Запомнена команда от друго хранилище може тук да е погрешна. Познато име на framework не установява инсталираната версия или правилата на проекта.

За малка промяна предоставете съответния модул, кода, който го извиква, тестовете и архитектурното решение. Добавяйте информация, когато проучването покаже конкретна нужда.

Използвайте инструкциите в хранилището за трайни правила

Файл с инструкции може да описва поддържаните команди, границите на модулите, изискванията за преглед и действията, които изискват решение на отговорник. Конвенцията AGENTS.md дава на инструментите за програмиране разпознаваемо място за тази информация. Поддръжката и приоритетът на инструкциите могат да се различават, затова проверете поведението на своя инструмент.

Пазете трайните правила на проекта в хранилището. Пазете текущата задача в заданието. Не превръщайте файла с инструкции в история на всеки разговор или списък с временни планове.

Полезна инструкция е „Изпълнете интеграционните тестове за права на достъп, когато маршрут променя поведението на достъпа.“ Неясна инструкция е „Винаги внимавайте със сигурността.“ Първата определя условие и действие, които проверяващият може да провери.

Сравнявайте инструкциите с кода

Инструкциите остаряват при промяна на команди, директории или архитектура. Ако ръководство посочва липсващ скрипт, прегледайте конфигурацията на пакетите. Ако документ твърди, че услуга е само за четене, прегледайте правата, преди да разчитате на това твърдение.

Запишете противоречието. Използвайте преки доказателства за текущата версия, за да разберете поведението на реализацията. Не отхвърляйте неявно съзнателно въведена политика, защото стар код я нарушава. Политиката и текущото поведение отговарят на различни въпроси.

Например ръководството може да забранява директен запис в споделен клон, докато стар скрипт все още го извършва. Правилният отговор е да запазите политиката и да поправите скрипта. Съществуващият код не разрешава повторение на забранено действие.

Пазете контекста подходящ и безопасен

Цяло хранилище може да съдържа данни за удостоверяване, частни тестови данни, клиентски експорти и стари логове от обслужването. Достъпът до хранилището не прави автоматично всеки файл подходящ за услуга с модел.

Използвайте одобрени инструменти и правила за обработка на данни. Изключете тайните стойности от контекста. Заменете клиентските примери с измислени данни, когато е възможно. Проверявайте свързаните инструменти, както и качените файлове: конектор за търсене може да извлече информация, която не е била в първоначалния промпт.

Инструкция „не четете тайни стойности“ в хранилището е полезно указание. Тя не заменя ограничаването на достъпа до хранилището за тайни стойности и чувствителните директории.

Оставете полезен запис за следващия човек

При завършване запишете промененото поведение, проверките и нерешените ограничения в pull request-а. Обновете трайната документация на проекта при промяна на поддържания работен процес. Избягвайте копирането на целия разговор с агента в хранилището.

Записът трябва да помогне на бъдещ разработчик по поддръжката да повтори работата, без да възстановява дълъг разговор. Препращайте към каноничните документи и поддържайте едно меродавно описание на всяко трайно правило.

Добрият контекст намалява повторните проучвания. Той прави грешките по-лесни за откриване, защото очакваното поведение и работещите команди са изрични.

Направете упражнението

Прегледайте един файл с инструкции в хранилище. Проверете три команди спрямо текущия проект. Намерете едно остаряло твърдение или липсващо ограничение. Предложете малка поправка чрез обичайния процес на преглед. Не включвайте данни за удостоверяване или клиентски данни.

Изтеглете работния лист (Markdown)
Проверете разбирането си ↑

Продължете ученето

Източници и допълнително четене

Свързани материали от Taiga

← Предишен урок: Напишете задание за агент