Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 3.93 KB

CONTRIBUTING.md

File metadata and controls

32 lines (25 loc) · 3.93 KB

Contributing Guidelines

Виды участия в роадмапе

Если вы не знаете, чем конкретно хотите заняться, то можете пробежаться по нашим Issues – их очень много на любой вкус.

Описание веток роадмапа

Если вы готовы взять в работу описание одной из веток, пройдитесь по нашему чек-листу:

  1. Проверьте, что на доске проекта в колонке "In progress" эта задача отсутствует, иначе вы рсикуете проделать двойную работу.
  2. Найдите соответствующий тикет с лейблом knowledge-base в Issues и заассайньте его на себя. На доске проекта передвиньте в статус "In progress".
  3. Создайте новый файл описания в /skills/role с использованием шаблона описания.
  4. Заполните столько секций, сколько вы готовы.
  5. Добавьте ссылку на новое описание в файле links.json, который использует генератор.
  6. Пришлите PR.

Процесс принятия изменений

В репозитории два мейнтейнера: etolstoy и DevAlloy

  1. Для мелкофиксов достаточно апрува одного из мейнтейнеров
  2. Для более сложных PR требуется апрув обоих мейнтейнеров

Мы стараемся разбирать PR и issue в течение 1-3 дней. Максимальный срок разбора – 7 дней.

Технические детали

Для всех изменений структуры источником правды является файл roadmap.mm. Для того, чтобы обновить его структуру или содержание, выполните следующие шаги:

  1. Внесите изменение в roadmap.mm с помощью Freemind и сохраните файл.
  2. Экспортируйте roadmap.mm в png со 100% масштабом через Freemind.
  3. Запустите скрипт python3 tools/gen_roadmap_contents.py для автоматического обновления базы знаний.