2.7 KiB
2.7 KiB
Правила работы агента в этом проекте
ГЛАВНОЕ ПРАВИЛО
НЕ "СОВЕРШЕНСТВОВАТЬ" РАБОЧИЙ КОД БЕЗ ЯВНОГО УКАЗАНИЯ.
Если код работает — не трогать. Никаких:
- рефакторингов "попутно"
- улучшений стиля
- добавления комментариев / docstring
- переименований переменных
- "пока уж заодно поправлю"
Делай только то, о чём явно попросили. Ничего лишнего.
Комментарии в коде
Комментарии — обязательны:
- В начале каждого файла при создании или правке — дата и время изменения
- На каждой функции/методе — краткое назначение
- На нетривиальной логике — почему сделано именно так (не "что делает", а "зачем")
Цель: любой агент в новом чате должен понять логику без дополнительных вопросов.
Темп работы
Не спешить. Перед каждым шагом — убедиться что предыдущий понят и согласован.
Документация
Всё важное фиксировать в doc/:
doc/architecture/— архитектура, стек, схемыdoc/api/— дизайн APIdoc/decisions/— принятые решения с обоснованиемdoc/infrastructure/— инфраструктура, кластер, сервисыdoc/errors/— ошибки и как решилиdoc/progress.md— трекер задач
Обновлять после каждого значимого изменения.
Именование
Имена должны быть уникальными и осмысленными по всему проекту:
- имена файлов
- имена функций/методов
- имена переменных/констант
- имена ресурсов (Terraform, Kubernetes и т.д.)
Цель: чтобы поиск по проекту находил нужные сущности без неоднозначности, а имя сразу отражало назначение.
Запрещены безликие и повторяющиеся имена вида handler.py, handle, data, value, temp без контекста.
Git
Коммитить и пушить после каждого завершённого этапа.