Програмування

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

Таким чином, кожен має право змінювати вихідний код Godot та надсилати ці зміни назад до попереднього проекту у формі патча (текстового файлу, що описує зміни). готовим до застосування способом) або – у сучасному робочому процесі, який ми використовуємо – через так званий «запит на витягування» (PR), тобто пропозицію безпосередньо об’єднати один або більше комітів (патчів) Git в основну розробку. відділення.

Внесення змін до коду вгору має дві великі переваги:

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

  • Вся спільнота виграє від вашої роботи, і інші учасники поводитимуться так само, додаючи код, який буде корисним для вас. На момент написання цієї статті понад 2000 розробників внесли зміни в код двигуна!

Щоб забезпечити хорошу співпрацю та загальну якість, розробники Godot дотримуються певних правил для додавання коду, наприклад, щодо стилю, який слід використовувати в коді C++ (відступи, дужки тощо) або робочого процесу Git і PR.

Хорошим місцем для початку є пошук проблем із тегом «хороший перший випуск» на GitHub.

Дивись також

Технічні деталі робочого процесу PR викладені в окремому розділі Робочий процес запиту на отримання.

Подробиці щодо вказівок щодо стилю коду та інструменту clang-format, який використовується для їх дотримання, описано в Настанови щодо стилю програмного коду.

Усі запити на вилучення мають пройти процес перевірки, перш ніж їх прийняти. Залежно від обсягу змін, може знадобитися деякий час, поки супроводжувач, відповідальний за змінену частину двигуна, надасть їх перевірку. Ми цінуємо всіх наших співавторів і просимо їх набратися терпіння, оскільки очікується, що в проекті з відкритим кодом, як-от Godot, буде набагато більше внесків, ніж людей, які їх підтвердять.

Щоб переконатися, що ваш час і зусилля не витрачені даремно, рекомендується спочатку перевірити ідею, перш ніж її реалізувати, і виставити на рецензію в якості PR. З цією метою Godot має «систему пропозицій. Його використання заохочується для планування змін та обговорення їх із спільнотою. Деталі реалізації також можна обговорити з іншими учасниками в чаті учасників Godot.

Примітка

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

Тестування та звітування щодо вад

Ще один чудовий спосіб внести свій внесок у движок — це тестувати випуски розробки або гілки розробки та повідомляти про проблеми. Також корисно повідомляти про проблеми, виявлені в стабільних випусках, щоб їх можна було виправити в гілці розробки та в майбутніх випусках обслуговування.

Тестування версій, які перебувають у розробці

Щоб допомогти з тестуванням, у вас є кілька можливостей:

  • Скомпілюйте движок із вихідних кодів самостійно, дотримуючись інструкцій на сторінці Compiling для вашої платформи.

  • Тестуйте офіційні двійкові файли попереднього випуску, коли вони оголошуються (зазвичай у блозі та на інших платформах спільноти), наприклад альфа-, бета-версії та збірки кандидатів на випуск (RC).

  • Тестувати «довірені» неофіційні збірки гілки розробки; просто запитайте членів спільноти про надійних постачальників. Якщо це можливо, найкраще використовувати офіційні двійкові файли або скомпілювати самостійно, щоб бути впевненим щодо походження ваших двійкових файлів.

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

Створення запису вади на GitHub

Для звітів про помилки Godot використовує засіб відстеження проблем GitHub. Коли ви почнете надсилати звіт про помилку, вам буде надано форму для заповнення. Будь ласка, намагайтеся дотримуватися його, щоб усі проблеми були послідовними та надавали необхідну інформацію.

Внески до документації

Є два окремих ресурси, які в Godot називаються «документацією»:

  • Посилання на клас. Це документація для повного API Godot, доступного для GDScript та інших мов сценаріїв. Його можна переглянути офлайн, безпосередньо в редакторі коду Godot або онлайн на Godot Class Reference. Щоб зробити внесок у посилання на клас, ви повинні відредагувати XML-файл, що відповідає класу, і зробити запит на отримання. Перегляньте Внесок у довідку про клас і Базовий буквар класу для отримання додаткової інформації.

  • Посібники та документація двигуна та її переклади. Це та частина, яку ви зараз читаєте, яка поширюється у форматі HTML. Його вміст генерується зі звичайних текстових файлів у форматі reStructured Text (rst), до якого ви можете внести свій внесок за допомогою запитів на отримання в репозиторії godot-docs GitHub. . Перегляньте Внески до документації для отримання додаткової інформації.

Сприяння перекладам

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

Перегляньте Редактор і локалізація документації для отримання додаткової інформації.