Отправка запроса Pull-Request

Основы

Сначала вам нужно настроить свою машину для возможности разработки под и со Sponge:

• прочтите статью Подготовка к разработке и настройте своё устройство

• ознакомьтесь с git и GitHub: Инструкция по Git(Hub)

• прочтите такие статьи, как Стиль кода и Указания по содействию

• ознакомьтесь со статьёй Рабочий поток данных Git-a для самого API и выполнения API

Если после этих шагов Вы чувствуете, что готовы к разработке Sponge, то решите, над чем конкретно вы хотите работать.

Написание PR

Исправление ошибок

Объясните в нескольких словах:

• с какими ошибками вы столкнулись, особенно

  • как они себя ведут

  • как они должны вести себя

• что вы исправили

• как вы это исправили

Основные добавления API

Итак, вы разработали довольно большое дополнение к API, которое вы хотите отправить в качестве PR. Хорошо! Конструктивные PR — вот что заставляет этот проект продолжать улучшаться. И это подводит нас к описанию PR.

В прошлом было несколько случаев, выходящих за рамки стандартов, например:

• Inventory API PR

• Data API PR

Конечно, это крайние случаи, но вот PR-ы, которые приняты и являются хорошим примером того, что должно быть включено в описание:

• Event Filtering PR

• Bans improvement API PR

Из этого можно извлечь следующие выводы:

• Ссылки на PR-ы в других реализациях располагаются наверху PR, этого можно достичь с помощью GitHub Markdown

*SpongeAPI* | [SpongeCommon](html link) | [SpongeDocs](html link)

• Четкое описание того, что представляет собой API PR, это может быть краткое описание, как если бы вы писали сочинение. Не более 4-х предложений, в зависимости от того, что это за функции.

• Конкретные примеры того кода, который обеспечивает плагинам новую функцию (и если это старые функции, зачем их нужно менять).