Files
SHiNE-server/AGENTS.md
T

3.9 KiB

Инструкции для агентов SHiNE

Этот файл относится к репозиторию SHiNE. По умолчанию писать документацию, пользовательские пояснения и сообщения коммитов на русском языке.

Сначала определить область работы

Область Код Правила и документация
Сервер, WebSocket/API, PostgreSQL SHiNE-server/ SHiNE-server/AGENTS.md, docs/API/
Блокчейн, Arweave SHiNE-server/shine-server-blockchain/ docs/Blockchain/README.md
Личные сообщения сервер и shine-UI/ docs/Personal_Messages/README.md, локальный AGENTS.md
Браузерный UI shine-UI/ shine-UI/AGENTS.md, docs/UI-Design/README.md
Solana/Anchor shine-solana/shine/ локальный AGENTS.md, docs/Solana_Architecture/README.md
ESP32 ESP32/ ESP32/AGENTS.md, инструкции конкретного устройства
Деплой и резервные копии deploy/ deploy/AGENTS.md, deploy/backup/AGENTS.md
Тестовый издатель tools/test-publisher/ локальный AGENTS.md

Общий каталог — docs/README.md; карта компонентов и потоков данных — docs/ARCHITECTURE.md. Правила сопровождения документов — docs/CONTRIBUTING_DOCS.md; после правки документации запускать python3 scripts/check_docs.py. Планы в TODO/ не считать описанием действующего поведения или разрешением на реализацию.

Постоянные правила

  • Прежде чем править подсистему, прочитать её локальный AGENTS.md и действующую документацию через docs/README.md. Архивные отчёты и старые планы не использовать как текущий контракт. При расхождении документа с кодом проверить реализацию и исправить документ либо явно отметить неопределённость.
  • Изменение поведения, формата, API, конфигурации или пользовательского сценария сопровождать обновлением соответствующего документа в том же наборе изменений. Не выдавать план, черновик или тестовое состояние за действующую функцию.
  • Формат блокчейна и контракт серверного API изменять только после отдельного явного согласия пользователя; документировать изменения в docs/Blockchain/ и docs/API/. Для добавления блока использовать AddBlock с актуальной вершиной цепочки.
  • Любые изменения и деплой production (shineup.me, server2.shineup.me) — только после отдельного явного согласия пользователя. Перед деплоем прочитать deploy/AGENTS.md и проверить резервную копию. Для деплоя использовать скрипты deploy/scripts/.
  • Секреты, приватные ключи, локальные конфиги, сборочные артефакты и логи не добавлять в git.
  • Коммиты, версии и merge выполнять по COMMIT_AND_VERSION_RULES.md. Не делать коммит или push без необходимости для задачи.