Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 4.53 KB

CONTRIBUTING.md

File metadata and controls

61 lines (50 loc) · 4.53 KB

Contributing

Прежде всего, спасибо, что нашли время для внесения своего вклада в проект! 👍

Как я могу посодействовать?

Workflow

  1. Форкните репозиторий
  2. Внесите свои изменения
    • Убедитесь, что коммиты следуют спецификации Conventional Commits

      Все это помогает формированию changelog'а и ознакомлением с историей проекта

      Также нелишним будет и указывать в каждом коммите (желательно в body) айдишник задачи в формате #{ID} (чтобы было линкование)

    • Убедитесь, что все проверки проходят

      $ npm run test
      # > Линтинг не нарушен
      # > Сборка не падает
    • Для модифицирования/добавления markdown-таблиц рекоммендуется использовать готовые сервисы (например этот)

  3. Предложите свой pull-request из вашей forked branch и укажите связанные issues (если они есть)
    • Перед созданием PR проведите как минимум одно self-review своих изменений, чтобы сэкономить время ревьювера

    • Также убедитесь, что описание вашего PR максимально внятно описывает решаемую проблему (позаботьтесь о ревьювере)

      Чем больше подробностей изложите в описании - тем лучше

      Можете ознакомиться с тем, какие делали pull-request до вас

    • Если все хорошо, можете для ускорения пингануть кого-нибудь из core-мейнтейнеров

      Если возникли проблемы - можете временно конвертировать ваш pr в черновик (см. панель справа)

      Или пометить тайтл PR с префиксом WIP:

    • Убедитесь, что проверка через CI прошла для вашего PR

      Наша общая цель - снизить затраты при ревью и добиться консистентности в кодовой базе 🤙