Как сотрудничать в Pull Requests для начинающих

Как сотрудничать в Pull Requests для начинающих

Содержание
  1. Совет № 1: Выберите правильный репозиторий
  2. Совет № 2: Выберите подходящий вам метод сотрудничества
  3. Совет № 3: Сохраняйте дополнительный PR
  4. Совет № 4 Просите о помощи
  5. Совет 5: Проявляйте благодарность

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

Совет № 1: Выберите правильный репозиторий

При совместной работе над запросом на исправление проекта с открытым исходным кодом, особенно такого, который имеет несколько репозиториев, вы должны быть уверены, что у вас есть правильный репозиторий. Например, я решил форкнуть репозиторий вводного курса OpenSauced, чтобы перевести содержание курса на французский язык вместе с Джеффри, участником из Того, Африка. Представьте себе, что вы просматриваете Google Drive или OneDrive и выбираете нужный файл, которым хотите поделиться со своими коллегами или коллегами в школе. После этого нужно клонировать хранилище. Ознакомьтесь с разделом ”Настройка” нашего руководства по контрибьютингу, чтобы получить представление о том, как выполнить этот процесс. Теперь выбор правильного репозитория - это только один шаг к совместной работе над запросами на исправление. Давайте рассмотрим другой.

Совет № 2: Выберите подходящий вам метод сотрудничества

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

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

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

Моб-программирование: Этот метод похож на парное программирование тем, что код пишет один человек. Отличие mob-программирования заключается в том, что группа разработчиков или технических специалистов управляет кодовой базой.
Поскольку у нас с Джеффри большая разница в часовых поясах, мы решили использовать асинхронный подход к нарушенному парному программированию. Чтобы нам было проще сотрудничать, я отправил Джеффри приглашение по электронной почте через GitHub. Если вы хотите узнать больше об этом процессе, ознакомьтесь со статьей Приглашение коллабораторов в личный репозиторий. Отлично, вы выбрали способ сотрудничества! 😀 Теперь перейдем к следующему совету.

Совет № 3: Сохраняйте дополнительный PR

Я знаю, что это звучит странно, но послушайте меня. Git и интернет иногда могут подводить с рабочими процессами. Например, я заметил, что в моей ветке было несколько конфликтов слияния. Поэтому я попробовал выполнить следующие команды Git, чтобы решить эту проблему:

git revert: Эта команда отменяет все изменения, сделанные в предыдущем коммите. Я решил использовать эту команду, чтобы избавиться от конфликтов слияния. К сожалению, это не сработало, так как большинство нужных мне коммитов были расположены не в том порядке, в котором я хотел.

git-force push: Эта команда заменяет историю коммитов на удалённом сервере вашей локальной историей. Другими словами, вся ваша работа может пропасть. К сожалению, именно такой исход произошел, когда я попытался использовать эту команду для устранения конфликтов слияния в ветке моего PR-перевода.

git-cherry-pick: Эта команда выбирает коммиты из одной ветки и помещает их в другую ветку. Вот тут-то и пригодился мой второй совет. Я вспомнил, что у Джеффри было большинство коммитов на его форке, поэтому я перешел в его ветку, использовал команду cherry-pick, и наша история коммитов была восстановлена.

Если вы хотите узнать больше об этих и других командах Git, которые следует использовать при внесении вклада в открытый код, ознакомьтесь с этой простой шпаргалкой по Git на сайте freeCodeCamp. Теперь, когда вы поняли силу дополнительного PR, давайте перейдем к другому совету!

Совет № 4 Просите о помощи

Я знаю, что в технических кругах часто говорят, что нужно пытаться разобраться во всем самому, но, как и в большинстве других вещей в жизни, бывают языки программирования или другие темы, связанные с техникой, в которых вы не разбираетесь. Поэтому вполне нормально попросить о помощи, если другие способы, которые вы испробовали, не помогли решить вашу проблему. Например, одна из сопровождающих OpenSauced заметила, что при нажатии на французский флаг боковая панель не переводит ее на переведенную французскую версию курса. Сначала я попробовал создать другую страницу, но это все равно не помогло. Тогда я обратился за помощью к Джеффри. Он указал, что проблема возникла из-за того, что пути к файлам, связывающим главы с каждым разделом, были написаны неправильно, и подсказал мне, как их исправить.они. После этого страницы заработали! 😊 А теперь, прежде чем отпустить вас, я хочу дать вам еще один совет.

Совет 5: Проявляйте благодарность

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

Отметьте их имена пользователей при описании вклада в форме вашего PR: Для этого сделайте следующее: @имя вашего партнера на GitHub.

Добавьте их имена в свои коммиты: Добавление их имен к вашим коммитам не только продемонстрирует ваши навыки сотрудничества (что может быть очень полезно на собеседовании), но и добавит значок GitHub в их профиль. Чтобы узнать, как это сделать, ознакомьтесь со статьей Создание коммита с несколькими авторами.

Вот и все, друзья. Пять советов о том, как сотрудничать с другими людьми над своими запросами на исправление. Выполнение этих рекомендаций на пути к открытому исходному коду значительно подготовит вас к работе в технической сфере. Если вы ищете проект и людей, с которыми можно поработать, загляните в наш репозиторий ”Стихи о пицце” и опубликуйте рецепт пиццы, факт о пицце в вашем родном городе или тривиальную информацию о пицце. Пока вы там, присоединяйтесь к нашему сообществу Discord, чтобы узнать о других проектах, в которые можно внести свой вклад. Мы с нетерпением ждем возможности работать с вами! 😊