Пул-реквесты

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

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

Примечание

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

См. раздел «Рекомендации по фиксации», если это относится к вам.

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

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

Форк

  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