Участие в проекте¶
Можно сообщать об ошибках, предлагать источники и правки, открывать Pull Requests после публикации репозитория. Все изменения проверяет автор. Автоматическое слияние отключается при настройке будущего репозитория. Автор
Как оформить предложение¶
- Укажите статью и конкретный фрагмент. Для ошибки приложите условия воспроизведения, ожидаемый и наблюдаемый результат.
- Для нового источника укажите автора, дату, версию и утверждение, которое источник подтверждает. Корпоративный кейс должен ссылаться на первичную публикацию или доклад и отделять реконструкцию от опубликованного факта.
- Соблюдайте категории FACT, INFERENCE, HYPOTHETICAL и UNKNOWN. Учебные параметры указывайте отдельно от опубликованных измерений. Редакционный стандарт
- Сохраняйте семь основных разделов, относительные ссылки и подписи Mermaid. Для кода укажите зависимости, версии, синтетические данные, ожидаемый результат и фактически выполненные проверки.
- Убирайте секреты, ключи, персональные и рабочие данные. Для сторонних материалов приложите происхождение, лицензию или разрешение, если материал допускается к распространению. Границы лицензирования
Перед Pull Request¶
Проверьте Markdown-ссылки, рендер изменённых Mermaid-блоков и строгую сборку MkDocs. Опишите выполненные и пропущенные тесты. Для изменения источников обновите реестр, для воспроизводимых проверок следуйте инструкциям QA. Исторические отчёты сохраняются, новый результат оформляется отдельно.