Рабочий поток данных Git-a для самого API и выполнения API
Разработка API
Основной процесс добавления изменений объясняется в разделе Инструкция по Git(Hub). Кроме того, мы предлагаем создать новую ветвь со значимым именем. С новой моделью ветвления вам нужно знать, на какой ветви нужно основать ваши PR, а где в последствии она должна будет слиться. Читайте о новой модели ветвления и управления версиями здесь: :doc:`../versioning
Кроме этого, мы требуем, чтобы вы обеспечили компиляцию модуля с помощью «gradle compileJava». Он запустит простую сборку исходных файлов. По успешном завершении, вы сможете зарегистрировать ваши изменения в репозитории SpongeAPI.
Developing the Implementation
Процесс для реализации почти такой же, как для API. Вы добавляете свои изменения, как описано в Инструкция по Git(Hub). Обратите внимание, что вы должны дать своим веткам значимые имена. С новой моделью ветвления вам нужно знать, на какой ветви нужно основать ваши PR, а где в последствии она должна будет слиться. Читайте о новой модели ветвления и управления версиями здесь: Система управления версиями и расположение ветвей репозитория
Run gradle compileJava
to check if everything compiles without errors.
Поскольку вы работаете над реализацией, есть вероятность, что ваша работа включит и изменения в API. Это нормально. Не забудьте сделать так, чтобы указатели на версию SpongeAPI соответствовали версии вашей ветви перед фиксацией и отправкой данных. Для этого вам, возможно, потребуется добавить подмодули в фиксацию (с git add SpongeAPI
и/или git add Mixin
) перед применением в вашей работе над реализацией.
Вы должны отправить pull-запрос перед тем, как ваше предложение будет отправлено в ваш форк или репозиторий.