RU Contributing - VVG-web/aurora-studio GitHub Wiki

Участие в разработке

Wiki · полное руководство: CONTRIBUTING · устройство: architecture

Цикл

python3 tests/run_tests.py                 # весь набор (несколько минут)
python3 tests/run_tests.py --smoke         # только быстрые инварианты по исходникам
python3 tests/run_tests.py --only <текст>  # проверки, в названии которых есть <текст>
python3 tests/run_tests.py --shard=1/3     # треть набора (так CI гоняет Windows)
ruff check --select F401,F841,B023,F821 scripts cockpit reports aurora.py

На каждый найденный дефект — тест, который красный без исправления, исправление и свой выпуск. Набор тестов — исполняемое описание движка: чтобы узнать, зачем существует правило, прочитайте докстринг теста.

Добавить

Что добавить Что сделать
команду скрипт в scripts/ (со строкой Панель: \ns:cmd`в докстринге), строку вcommands.txt, строку в engine_manifest.txt, строку в скилле aurora-vault`, пересобрать справочники, тест, CHANGELOG
модуль источника папку connectors/<id>/ с connector.json, SKILL.md и скриптом — модули источников
раздел панели папку cockpit/modules/<id>/ — манифест, разметка, скрипт, строки с префиксом раздела
оформление файл cockpit/skins/<имя>.css — только токены, оба состояния темы
язык интерфейса python3 scripts/kit_i18n.py --new <код> "<название>", затем заполнить cockpit/i18n/data/<код>.json и запустить --check
страницу wiki файл в wiki/ и его пара в wiki/ru/, ссылка из README.md — тесты проверяют ссылки и парность

Выпуск

  1. Поднимите VERSION (и UI_VERSION в cockpit/ui/panel.js — тест их сравнивает) и добавьте в CHANGELOG.md запись ## X.Y.Z — суть (по-русски: что изменилось для человека, дефекты, найденные после реализации, — отдельно; ломающее изменение схемы помечается BREAKING с шагом миграции).
  2. Начните сообщение коммита с версии: vX.Y.Z: суть. python3 tests/check_release.py, набор тестов и kit_i18n.py --check должны быть зелёными.
  3. Слейте в master, когда CI зелёный. Выпуск создаёт CI: workflow release.yml дожидается тестов, читает VERSION и — если выпуска этой версии ещё нет — ставит тег на коммит, поднявший версию, и публикует GitHub Release с текстом из CHANGELOG.md. Нет записи в журнале изменений — нет выпуска (workflow падает с понятной ошибкой).
  4. Выпуски идут по одному: дождитесь появления выпуска, прежде чем сливать следующий.

Авторство в коммитах, pull request и выпусках — человека: никакой инструмент не указывается автором или соавтором.

Принципы, которые соблюдаются

  • Сначала скрипт, потом модель. Массовая операция — детерминированный скрипт с пробным прогоном; модель только судит.
  • Не переписывать то, что движок не писал. Тела словарей и документов, подвалы с историей, прежние тезисы.
  • Зеркало детерминировано. Один источник → те же байты.
  • Раскладка папок фиксирована и везде одна; манифест движка — белый список.
  • «Только чтение» значит только чтение: сервер MCP, предпросмотр панели и команды наблюдения ничего не пишут.

Эта wiki собирается из папки wiki/ репозитория — правьте страницы там, изменения, сделанные здесь, будут перезаписаны. · Home

⚠️ **GitHub.com Fallback** ⚠️