Демистификация взносов с открытым кодом

1656516863 demistifikacziya vznosov s otkrytym kodom

от Вассима Чегама

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

r7X7hiwNT6pS1mkawFyctIUFhKczgWbQmRjd

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

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

Я предполагаю, что вы уже знакомы с Git. Если это не так, вот полное руководство для вас.

Определите проект, над которым хотите работать

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

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

Тебе решать. Просто выберите один!

Развитие проекта

Прежде чем начать вклад, нужно расширить проект до своей учетной записи GitHub (при условии, что вы используете GitHub). Этот процесс в основном копирует исходный проект в ваши собственные проекты GitHub, так что вы можете иметь собственную копию проекта для работы.

-U5Pk9zzGkJhzgB359COR4lRyLqlcNc2J3cN

Клонируйте и установите зависимости

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

NSC0Id48dj5wzbdUhz8GtFMrAHJv1l20rqta

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

После локального клонирования проекта вам необходимо внимательно прочитать файл CONTRIBUTING.md или README.md или любой другой файл, описывающий все необходимые шаги для локального запуска и создания проекта. Если вы застряли, просто обратитесь за помощью к сопроводителям проекта и они с радостью поддержат вас.

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

Чем вы можете помочь

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

Вклад в проект с открытым исходным кодом означает не только написание и решение технических проблем. Вклады с открытым кодом практически не имеют ограничений или пределов. Они могут быть (от быстрого к более привлекательному):

  1. Используя инструмент и благодаря команде, которая над ним работает,
  2. Продвижение проекта на мероприятиях или в Интернете,
  3. Помогая отвечать на вопросы,
  4. Устранение ошибок в документации,
  5. Написание или перевод документов,
  6. Помощь в воспроизведении ошибок и сообщенных проблем,
  7. Рефакторинг существующего кода
  8. Исправление – технических – ошибок,
  9. Написание модульных тестов
  10. Внедрение новых функций,
  11. Отрицание дизайна основной архитектуры
  12. Ты назвал это!

По сути это все, что вы можете сделать, чтобы помочь улучшить проект.

Определите проблему, которую нужно «исправить»

Под «исправлением» мы подразумеваем «оказание помощи». Обычно я рекомендую тем, кто впервые добавляет, начинать с малого. Выберите то, что вы можете легко и быстро исправить. Опечатки в документации отличные. Кроме того, вы сможете прочитать всю документацию проекта и еще больше ознакомиться с проектом – это отлично, если вы хотите получить картину высокого уровня!

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

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

Применение «исправления»

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

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

Совершите и нажимайте свои изменения

Когда ваше решение готово, вы должны гордиться собой! Вы проделали тяжелую работу, остальная лишь формальность.

Итак, далее вам нужно зафиксировать и внести изменения в собственную копию проекта – ту, которую вы создали!

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

UrAUCrpG7tSDOt6RrvVc3J4-X4EsyBwQDC6O

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

Отправьте PR-Pull Request

Теперь вы готовы прислать свои изменения в исходный проект — вышеупомянутый проект. Для этого вам нужно будет открыть Pull Request.

Oi9p1Em-hkCQ2s4UtWc1RqlwUSpV65Bi5gHs

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

Если сопровождающие проекта не могут объединить ваш PR по каким-либо причинам (обычно техническим), не расстраивайтесь и не разочаровывайтесь! Сделайте это еще раз или двигайтесь дальше и решайте другую проблему. Это вполне нормально, это часть взноса.

Надеюсь, теперь у вас есть четкое представление о вкладах с открытым кодом и насколько они легки.

На здоровье.

Следите за мной @manekinekko в Twitter, чтобы узнать больше об Open Source.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *