Patch & Commit – Латка і Фіксування

Submit Patches – Подавання Латок

Перші кілька разів, коли ви вносите зміни до посібника, вам потрібно буде подати їх як латки для перегляду адміністратором. Це лише для того, щоб переконатися, що ми підтримуємо якісний посібник користувача, і щоб ви випадково не зламали нічого життєво важливого, перш ніж звикнути до системи.

Щоб подати латку, здійсніть наступний процес:

  1. Зробіть бажані для вас зміни.

  2. Створіть файл латки, запустивши:

    svn diff > filename.diff

    Це створить простий текстовий файл, що показує, який текст було додано, вилучено або змінено, між вашими робочими файлами та центральним репозиторієм.

    Якщо ви створили або видалили файли, вам потрібно буде запустити svn add /path/to/file або svn rm /path/to/file перед створенням відмінності diff. Щоб подивитися список задіяних файлів, запустіть svn status.

  3. Вивантажте файл відмінності тут – Upload the diff file here. Якщо ви ще не маєте акаунту, то ви можете зареєструвати його – register for one.

  4. Після подання файлу diff, вас попросять «Створити нову Ревізію» – «Create a new Revision», перед тим, як ви зможете додати назву та опис ваших змін.

  5. Будь ласка, перевірте, чи проєкт цієї Документації призначений в полі тегу, щоб повідомити команду про вашу латку. Ви можете також сконтактуватися – contact з командою через список розсилки або Чат Blender’а – Blender Chat.

  6. Вони рецензують вашу латку та повідомлять вас про будь-які зміни, котрі ви могли б зробити. Якщо проблем немає, то ваша латка буде прийнята і, далі, буде подана командою з ваших латок.

Примітка

Якщо ваша латка включає зміни щодо додаткових зображень, просто прикріпіть їх, коли будете створювати ревізію.

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

Дивись також

See Release Cycle – Цикл Випуску for documentation on how to make commits to a specific release branch and how to create merge commits.

Commit Directly – Фіксування Безпосередньо

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

Все, що треба для цього, це запустити:

svn commit -m "This is what I did"

Якщо ви залишите -m "message", то отримаєте запит увести це повідомлення у текстовому редакторі.

Не забувайте завжди запускати svn update перед фіксуванням.

Потім вас запитають ваше ім’я користувача та пароль (з developer.blender.org) перед фіксуванням зміни.

Примітка

Переконайтеся, що використовуєте ваше ім’я користувача (з урахуванням регістру), а не ваш емейл.

Ваші модифіковані файли вивантажуються в центральний репозиторій, щоб інші могли працювати з ними та продовжувати співпрацювати. Фіксації відстежуються в репозиторіях Diffusion. Незабаром ваші зміни стануть видимими в онлайновому посібнику.

Writing a Good Commit Message – Написання Хорошого Повідомлення щодо Фіксації

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

Наприклад, фіксація rBM8473 включає описове вказування змін, зроблених разом з хешем rBa71d2b260170. Цей хеш може бути витягнуто з URL, наданого в Documentation task для конкретного прийдешнього випуску.

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

Написання хороших повідомлень про фіксацію допомагає адміністраторам відстежувати внесені зміни та гарантує, що всі нові функції належним чином задокументовані.