Заплатки и фиксации

Отправка заплаток

The first few times you make changes to the manual, you will need to submit them as patches for an administrator to review. This is just to make sure that we maintain a quality user manual, and that you do not accidentally break anything vital before you get used to the system.

Чтобы отправить заплатку, выполните следующие шаги:

  1. Make any changes that you want.

  2. Создайте файл заплатки, выполнив команду:

    svn diff > filename.diff

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

    Если вы создали или удалили файлы, вам нужно будет запустить команды svn add /путь/к/файлу или svn rm /путь/к/файлу перед созданием файла заплатки. Для просмотра списка затронутых файлов воспользуйтесь командой svn status.

  3. Загрузите файл заплатки сюда. Если у вас ещё нет учётной записи, вы должны сперва зарегистрироваться.

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

  5. Please check if the Documentation project is assigned in the tag’s field in order to notify the team of your patch. You can also contact the team over the mailing list or Чат Blender.

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

Примечание

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

Straightforward patches are bound to be accepted very quickly. Once you get accustomed to making changes and no longer need feedback, we cut out the middle man and give you direct access to edit the manual.

Непосредственная фиксация

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

Всё, что вам нужно для этого сделать – это выполнить команду:

svn commit -m "This is what I did"

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

Не забывайте всегда запускать команду svn update перед фиксацией.

Перед тем, как изменения будут зафиксированы, вас попросят ввести своё имя пользователя (то, с которым вы регистрировались на developer.blender.org) и пароль.

Изменённые вами файлы загружаются в центральное хранилище, так что над ними смогут продолжить работу другие люди. Фиксации отслеживаются в хранилищах Diffusion. Вскоре после этого ваши изменения станут видимы в онлайн-руководстве.

Writing a Good Commit Message

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.