- 💡 Создавайте issue, если вы видите, что мы не хватили какую-то область ответственности тимлида, где-то ошиблись или у вас просто есть отличная идея для обсуждения.
- 🚫 Присылайте Pull Request с исправлением фактических ошибок.
- 📚 Дорабатывайте базу знаний – как новые ветки, так и отдельные секции в уже готовых (например, "Как прокачать", "Примеры поведения" или "Список литературы").
- 👨🏻💻 Присылайте модели тимлидов своих компаний – мы их добавим в раздел с примерами.
Если вы не знаете, чем конкретно хотите заняться, то можете пробежаться по нашим Issues – их очень много на любой вкус.
Если вы готовы взять в работу описание одной из веток, пройдитесь по нашему чек-листу:
- Проверьте, что на доске проекта в колонке "In progress" эта задача отсутствует, иначе вы рискуете проделать двойную работу.
- Найдите соответствующий тикет с лейблом
knowledge-baseв Issues и заассайньте его на себя. На доске проекта передвиньте в статус "In progress". - Создайте новый файл описания в
/skills/roleс использованием шаблона описания. - Заполните столько секций, сколько вы готовы.
- Добавьте ссылку на новое описание в файле
links.json, который использует генератор. - Пришлите PR.
В репозитории два мейнтейнера: etolstoy и DevAlloy
- Для мелкофиксов достаточно апрува одного из мейнтейнеров.
- Для более сложных PR требуется апрув обоих мейнтейнеров.
Мы стараемся разбирать PR и issue в течение 1-3 дней. Максимальный срок разбора – 7 дней.
Для всех изменений структуры источником правды является файл roadmap.puml. Для того, чтобы обновить его структуру или содержание, выполните следующие шаги:
- Внесите изменение в
roadmap.puml, придерживаясь стандартовPlantUML, и сохраните файл. - Выполните команду
pip3 install -r tools/requirements.txt - Зайдите в папку
toolsи выполните командуpython3 gen_contents.pyдля автоматического обновления mindmap и png.
Для проверки орфографии в проекте нужен установленный yaspeller
- Запустите
yaspeller --config .yaspellerrc.json .и он покажет предполагаемые ошибки. - Если слово корректно, но yaspeller думает что это ошибка – добавьте в файл
.yaspellerrc.jsonв массивdictionary. - Если это паттерн – например, имена в названиях книг – имеет смысл добавить regexp в поле
ignoreText. - Блоки ссылок можно завернуть в специальные markdown-комментарии.
<!-- yaspeller ignore:start -->
ссылка
ссылка
<!-- yaspeller ignore:end -->
Для того, чтобы не терять букву Ё в словах используется eyo
Запустите npx eyo --only-safe --in-place "**/*.md" в корне проекта. Благодаря флагу --only-safe будут исправлены только точно потерянные Ё, а --in-place автоматически заменит.
Для того, чтобы файлы соответствовали единому стилю (отступы, кодировка и т.д), в некоторых IDE необходимо установить editorconfig плагин.