Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
16 lines (12 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

16 lines (12 loc) · 1.6 KB
Raw

Обновление справочника

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

  2. Не редактируйте api/despair-api.json, docs/API.md и docs/reference/*.md вручную: они генерируются tools/build_api.py.

  3. Меняйте извлечение или исходные материалы только с объяснением и проверяемым свидетельством. Не заменяйте неизвестные типы и имена предположениями.

  4. Выполните:

    python tools/build_api.py
python tools/build_api.py --check
python -m unittest discover -s tests -v

  5. Если меняется состав данных, обновите статистику и ограничения в README и анализе. При изменении JSON-схемы увеличьте schema_version и объясните миграцию.

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