Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.62 KB

File metadata and controls

37 lines (26 loc) · 2.62 KB

Руководство для контрибьютеров

Способы внести вклад

  • Сообщить об ошибке — создайте issue с описанием и шагами воспроизведения.
  • Предложить улучшение — issue с меткой или текстом «предложение».
  • Улучшить документацию — правки в README, docs, комментариях в коде.
  • Написать код — исправления, доработки API, тесты.

Процесс разработки

  1. Форкните репозиторий, создайте ветку под задачу (например fix/описание или feat/название).
  2. Установите зависимости: opm run install (или opm install --dev -l).
  3. Вносите изменения. Запуск тестов: opm test. Сборка пакета: opm run build.
  4. Оформите коммиты по Conventional Commits (например feat:, fix:, docs:). Сообщения — на русском, где уместно.
  5. Отправьте ветку и создайте Pull Request. Опишите изменения и при необходимости укажите связанные issues.

Стандарты кода

Подробности — в .cursor/rules/ (по важности для разработки):

  • project-conventions.mdc — язык, именование модулей и методов, коммиты, структура проекта.
  • os-code-style.mdc — оформление кода OneScript (пустые строки, структуры и т.д.).
  • prometheus-api-usage.mdc — использование API: фасад Prometheus, низкоуровневые модули.
  • docs-and-spec.mdc — расположение документации и спецификаций (каталог docs/).
  • examples-comments.mdc — оформление комментариев в примерах (examples/).

Комментарии в коде и сообщения — на русском.

Вопросы и связь

Внося вклад, вы соглашаетесь с тем, что он будет лицензирован под MIT License.