Вклад в gRPC: пошаговое руководство

Примечание: Этот документ не предназначен для сотрудников Google.

Предварительные условия

Для вклада в кодовую базу gRPC вам потребуются следующие элементы:

1. Активная учетная запись GitHub
2. Понимание Git и GitHub
3. Знание того, как создавать вилки репозиториев, клонировать репозитории, объединять, перебазировать, разрешать конфликты, отправлять, получать и извлекать данные и т.д.
4. Git установлен и работает на вашем компьютере
5. Знание используемого языка, который может быть C++, Python, Ruby, Objective-C, PHP или C#.

Шаги для вклада в код gRPC C++

Репозиторий GitHub для gRPC на основе C (C++, Python, Ruby, Objective-C, PHP, C#) находится по адресу https://github.com/grpc/grpc.

Создание вилки и клонирование репозитория

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

1. Создайте свою собственную вилку из https://github.com/grpc/grpc.

   

2. Клонируйте свою вилку на ваш локальный компьютер.

Подготовка и отправка вашего коммита

1. В вашем клонированном репозитории создайте новую ветку от master.
2. Затем подготовьте коммит для файлов, которые вы хотите внести.
3. Сделайте коммит в эту ветку.
4. Отправьте коммит в вашу вилку на GitHub.

Обратите внимание, что ваши коммиты должны соответствовать этим рекомендациям.

Подготовка запроса на слияние (Pull Request)

После отправки вашего коммита посетите https://github.com/grpc/grpc. Если создание вилки, создание ветки, коммит и отправка прошли успешно, вы увидите следующее сообщение:

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

Создайте запрос на слияние.

Статус запроса на слияние - Безопасный обзор

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

Если вы видите Не охвачено на экране EasyCLA, как показано на следующем изображении, нажмите на указанную ссылку, чтобы начать процесс авторизации.

Вы увидите серию экранов:

1. Выберите Авторизовать LF-Engineering:

1. Выберите тип участника:

1. Выберите Подписать CLA:

Через некоторое время после цифрового подписания документа EasyCLA будет отображаться как Охвачено.

Через несколько часов вы заметите нового "ответственного" назначенного к запросу на слияние.

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

1. Вы завершаете обзор кода и исправляете комментарии.
2. Ваш модератор может добавить несколько меток по мере необходимости.

Статус запроса на слияние - Зеленый

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

Одобрение запроса на слияние

Для непростых запросов на слияние существует тщательный процесс обзора кода. Вы можете узнать больше о процессе и требованиях здесь.

После исправления обзора кода вы наконец получите одобрение. После получения одобрения вы можете отправить запрос на слияние.

Отправка

Вы не можете отправить или объединить запрос на слияние через GitHub.

После получения одобрения от модератора сотрудник Google запустит процесс отправки. Когда отправка произойдет:

1. Коммит с вашими изменениями, а также несколькими дополнительными изменениями форматирования, будет добавлен в ветку grpc/master.

2. Запрос на слияние, который вы изначально создали, будет закрыт.