Станьте эффективным мейнтейнером с открытым исходным кодом

Что нужно, чтобы быть хорошим мейнтейнером с открытым исходным кодом? Я знаю из личного опыта, что навыки, необходимые для этого, не даются многим инженерам естественным образом.

Вот мои советы о том, как стать эффективным сопровождающим с открытым исходным кодом 👇

1. Будьте готовы к большому количеству уведомлений

Это отличный совет для начинающих сопровождающих: вы получите много сообщений.

«Будьте готовы к большому количеству уведомлений. Это может быть немного шокирующим, особенно если действительно увлеченный человек наткнется на ваш репозиторий и сделает много проблем или пулл-реквестов за один раз. Это хорошо, и это означает, что люди постоянно учатся. Так что иди с этим».

2. Упростите новичкам начало работы

Написание четкой и подробной документации и выявление проблем, подходящих для новичков, сделают ваше сообщество более приветливым и сэкономят время для сопровождающих.

Вот мейнтейнеры о том, как это сделать хорошо:

«В EddieHub у нас есть канал «хороший первый выпуск», где люди могут найти хорошие первые выпуски, чтобы начать работу. Тем не менее, для людей, которые размещают эти ссылки, просто убедитесь, что они являются хорошими первыми выпусками, убедитесь, что у них есть шаги, чтобы люди поняли, как им нужно двигаться».

«Убедитесь, что в вашем файле Readme есть действительно хорошее краткое руководство, чтобы люди могли начать работу. Дело не только в том, как вы клонируете репозиторий, для этого есть много официальных источников. Убедитесь, что вы также освещаете конкретные части вашего проекта в своем репозитории, а не то, что люди найдут, найдя официальную документацию».

3. Будьте ясны в документации. Будьте действительно ясны

Практически невозможно сделать вашу документацию достаточно ясной.

Один сопровождающий: «Убедитесь, что у вас действительно четкие файлы участников, сказав, например, если вы хотите, чтобы люди, например, писали запросы на вытягивание определенным образом, четко объясните это в файле участника, чтобы люди знали, как это сделать. делать вклад. И тогда будет меньше туда и обратно».

Совет 1: читайте документацию вслух. Это то, что вы сказали бы другому человеку? Если нет, измените его на то, как вы бы это сказали.

Совет 2: отличный проект, подходящий для новых участников, — это провести тестирование вашей документации под давлением. Пусть несколько новичков прочитают документацию и узнают, какие у них есть вопросы. Затем обновите документацию, чтобы отразить ответы на эти вопросы.

4. Будьте добры к участникам

Помните, что эти участники — добровольцы, которые решили потратить свое время на улучшение вашего проекта. Ответьте на их вклад с заботой.

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

Другой сопровождающий:

«Будьте добры к людям, которые хотят внести свой вклад в ваш репозиторий. Даже если они делают что-то не так, это не по злой воле, они здесь, потому что хотят внести свой вклад. Многие из них молоды, постарайтесь помочь им научиться. И просто постарайся быть настолько добрым, насколько это возможно. Потому что легко принять что-то неправильно, например, письменное сообщение, когда вы отвечаете кому-то в вопросе или запросе на включение ».

5. Поощряйте несколько обзоров кода за один запрос на слияние

Обзоры кода — это волшебный метод, помогающий улучшить код и улучшить навыки и знания программистов. Дело не только в авторе кода — рецензенты кода часто учатся, рецензируя.

И хотя один обзор кода — это хорошо, два или три рецензента могут быть еще лучше.

Один сопровождающий: «Всегда приятно иметь несколько обзоров. Запросы на вытягивание с двумя или тремя обзорами означают, что был отличный (асинхронный) разговор и координация, что помогает проекту».

6. Автоматизируйте процессы

Чем больше можно сделать для улучшения кода и основных процессов, тем меньше работы остается для сопровождающих и участников, и тем больше они могут сосредоточиться на том, что могут внести.

Один сопровождающий:

«Я бы сказал, автоматизировать как можно больше. Так что, если у вас есть линтеры, запустите их на действиях GitHub. Не отвлекаться от сотрудничества или общения, которое вы собираетесь делать с сообществом, а сосредоточить это сотрудничество и общение на том, что важнее.

Нет смысла говорить, что вы пропустили точку с запятой, у вас неправильный отступ, вы хотите, чтобы это было автоматизировано, а затем вы можете обсудить более интересные и забавные вещи».

Совет для профессионалов: помощь в автоматизации инструментов для сообщества — еще один отличный способ внести свой вклад, будь то в кодовой базе или в каналах связи.

7. Установите четкие ожидания в отношении временных обязательств и обновите их соответствующим образом

Это обратная сторона «Фокуса» для участников. Если вы являетесь сопровождающим, будьте реалистичны в отношении того, сколько времени вы действительно можете выделить, и выполняйте это обязательство. Если ситуация изменится, и вам придется сократить время, сообщите об этом заранее.

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

Один сопровождающий: «Не расстраивайте себя, думая, что я должен посвящать этому много-много часов каждую неделю, потому что я вызвался быть сопровождающим. Если вы хотите быть сопровождающим на определенном сайте и не чувствуете, что у вас будет время, обсудите это с человеком, которому принадлежит репозиторий в этом случае, просто чтобы вы не почувствуй себя напряженным».

Также опубликовано здесь.