Запросы на включение

На этой странице описаны инструменты, используемые для внесения и проверки кода.

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

Примечание

Авторы, которым предоставлен доступ к фиксации, могут выполнять фиксацию в основном репозитории без необходимости его форка (копирования (fork)).

См. Рекомендации по фиксации (Commit Guidelines), если это относится к вам.

Настройка единожды

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

Форк (Fork)

  1. Перейдите в репозиторий Blender и нажмите кнопку «Fork».

  2. Подтвердите форк с настройками «по умолчанию».

  3. Теперь вам нужно будет добавить свой личный форк в качестве удалённого в локальный репозиторий git. Нажмите SSH, чтобы увидеть правильный URL-адрес, а затем добавьте его следующим образом:

    git remote add me [email protected]:<USERNAME>/blender-manual.git

Примечание

Для отправки в форк репозиторий вам понадобится ключ SSH. Если у вас ещё нет файла ~/.ssh/id_rsa.pub, есть простая команда для генерации таких ключей, которая работает в Linux, macOS и в Git Bash в Windows:

ssh-keygen

Эта команда сгенерирует закрытый ключ «id_rsa» и открытый ключ «id_rsa.pub» в ~/.ssh. Закрытый ключ ни в коем случае нельзя показывать или отправлять кому-либо ещё, чтобы не поставить под угрозу вашу учетную запись, но открытым ключом можно безопасно делиться.

Содержимое ~/.ssh/id_rsa.pub можно скопировать и вставить в настройки учётной записи на project.blender.org , после нажатия «добавить ключ». Для ключа SSH подойдёт любое имя.

Рабочий процесс

Рабочий процесс с запросами на включение можно найти в документации разработчиков Blender.

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

Рекомендации для рецензентов

  • Текст запроса на включение должен использоваться в качестве сообщения о фиксации git (подробности см. в guidelines).

  • Четко указывайте, когда некоторые изменения необходимо учесть перед их фиксацией, без необходимости повторной проверки.

  • Если запрос на включение не будет одобрен, ожидается, что автор выполнит ещё одну итерацию.

  • Если изменение требует сначала согласования задачи проектирования, приостановите запрос на включение, добавив в заголовок префикс WIP:, указывающий, что автор считает запрос на включение не готовым к объединению. Никакого обзора не ожидается, если автор специально не попросит об этом.

  • Ожидается, что авторы ответят на запросы на включение в течение 3 рабочих дней.

  • Добавьте метки на соответствующие модули/проекты.

  • Поощряйте новых авторов делать рецензии: это хороший способ обучения и важно для развития проекта.

Советы

  • Чтобы получить файл исправления, добавьте «.patch» в конец URL-адреса запроса на включение. Пример:

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • Оформить запрос на включение в отдельный заголовок (не оставляющий после себя ветку). Пример:

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD