Рекомендации по фиксации (Commit Guidelines)

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

Вы можете совершать коммиты из своего клиента Git или с помощью инструмента командной строки Git. Следующая команда создаст коммит и отправит его в центральный репозиторий:

git commit -m "This is what I did"
git push

Если вы опустите -m "сообщение", вас попросят ввести его в текстовом редакторе.

Совет

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

Чтобы этого избежать, обновите локальный репозиторий перед фиксацией (запустите make update).

См.также

Blender’s Git usage guide

См.также

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

Написание хорошего commit-запроса

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

Например, коммит rBM8473 включает в себя наглядное описание внесённых изменений вместе с хешем rBa71d2b260170. Хэш можно извлечь из URL-адреса, указанного в задаче документации (Documentation task) для конкретного предстоящего релиза.


Другие более общие изменения не обязательно должны соответствовать вышеуказанной политике, однако всё равно важно чётко указать в описании, какие изменения вы внесли и почему. Может быть полезно добавить к заголовку коммита префиксное слово, например Cleanup: или Fix:, когда вы выполняете общие очистки или исправления соответственно.

Написание хороших запросов фиксации (commit messages) помогает администраторам отслеживать внесённые изменения и обеспечивает правильное документирование всех новых функций.