Используйте VS Code для сообщения об ошибках, чтобы снизить планку для новых участников проекта

Хотя это замечательно, когда ваш проект с открытым исходным кодом пользуется все большей популярностью, по мере роста его использования возрастает и сложность его поддержки. Это усложняет понимание, вовлечение и вклад. То, что продолжает быть второй натурой для основных участников благодаря постоянно развивающимся племенным знаниям, которые они приобрели, работая над кодовой базой каждый день, быстро перестает масштабироваться. Неизбежно наступает переломный момент, когда количество ошибок и отчетов о функциях превышает пропускную способность сопровождающих. Единственное реальное решение — снизить барьеры для входа и дать возможность большему количеству людей вносить свой вклад. Это постоянный процесс, и чем раньше вы его начнете, тем лучше.

Вовлечение сообщества в проекты с открытым исходным кодом. Copyright by Bessemer Venture Partners.

Участие в проектах с открытым исходным кодом — идеальный способ приобрести новые навыки, вырасти как разработчик и начать завоевывать определенный профессиональный авторитет. Однако когда вы начинаете с нуля, невероятно сложно понять, как начать. Если только проект не вложил значительные усилия в устранение ошибок и подготовку документации/инфраструктуры, большинство проблем или работ по разработке требуют большого контекста. Это представляет собой большую проблему как для сопровождающих, так и для потенциальных участников с ограниченным временем.

Вот несколько способов для сопровождающих открытого исходного кода сделать свои проекты более доступными:

  1. Увеличивайте разнообразие проблем, связанных с проектом — не все должно быть ошибкой в коде — улучшение документации так же ценно, как и хороший код.
  2. Разбивайте проблемы на атомарные единицы, чтобы уменьшить количество контекстной информации, необходимой для работы над проблемой.
  3. Предоставляйте дополнительную информацию, которая четко передает, как должна работать функция, какие изменения вы хотели бы видеть в запросе на доработку и на какие потенциальные «ямы» следует обратить внимание.

Устранение этих моментов может оказать немедленное воздействие, но это все равно не даст четкого руководства о том, где новички могут начать вносить свой вклад.

Управление проблемами через что-то вроде Github — отличное место для начала, но оно все равно оставляет большой разрыв между проблемой, веткой обсуждения и реальным кодом, который нужно создать. Чтобы автоматизировать и упростить этот процесс, мы в Stateful работаем над расширением VS Code, которое позволяет устранить этот разрыв, под названием VS Code Issue Explorer:

Расширение позволяет вам определять проблемы с дополнительной контекстной информацией в виде ссылок на код и отдельных комментариев. Эти ссылки затем вставляются в шаблон проблемы GitHub и автоматически выделяются в VS Code при навигации по файлам. Это также предлагает совершенно новый способ для всех, кто хочет внести свой вклад, выявлять проблемы в коде, просто пролистывая кодовую базу. Это отличный способ ознакомиться с существующими проблемами и их связью с кодом.

Мы все любим набрасывать старый добрый комментарий // ToDo поверх функции, когда она нуждается в рефакторинге, но эти комментарии часто теряются, игнорируются и совсем не прозрачны для заинтересованных начинающих авторов. Страница проблем на GitHub часто имеет удивительно высокий уровень посещаемости и служит общей отправной точкой для потенциальных новых участников. Создавая продуманные, хорошо прописанные отчеты об ошибках со ссылками на затронутые строки кода, проекты могут снизить барьер для входа и, возможно, увеличить количество входящих PR. Увеличение числа участников в идеале ведет к более счастливому и здоровому проекту, так что приступайте!

Расширение VS Code Issue Explorer теперь доступно на VS Code Marketplace и с открытым исходным кодом на GitHub. Дайте нам знать, что вы думаете, и расскажите нам об этом в Discord или подняв вопрос.

Оцените статью
devanswers.ru
Добавить комментарий