Patch & Commit

Submit Patches

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.

In order to submit a patch, follow this process:

  1. Make any changes that you want.

  2. Create a patch file by running:

    svn diff > filename.diff

    This creates a simple text file that shows what text was added, removed or changed between your working files and the central repository.

    If you have created or deleted files, you will need to run svn add /path/to/file or svn rm /path/to/file before creating the diff. To see a list of affected files, run svn status.

  3. Upload the diff file here. If you do not have an account already, you can register for one.

  4. After submitting the diff, you will be asked to «Create a new Revision» before you can add a title and description of your changes.

  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 Chat.

  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.

Примечание

If your patch includes changes to or additional images, simply attach them when you are creating the revision.

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.

См.также

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

Commit Directly

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.

All you need to do now is run:

svn commit -m "This is what I did"

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

Do not forget to always run svn update before committing.

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

Примечание

Make sure to use your username (case sensitive) and not your email.

Your modified files are uploaded to the central repository for others to work with and continue collaborating. Commits are tracked in the repositories Diffusion. Soon after your changes become visible in the online manual.

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

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

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

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

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