Указания по содействию

Предупреждение

This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.

Мы всегда будем нуждаться в разработчиках, которые могут улучшить SpongeAPI. Совершенству нет предела. Если вы - разработчик, и хотите помочь, отбросьте сомнения. Просто следуйте нашим советам.

Примечание

Разработчикам, которые проявляют решительность и последовательность в своих вкладах в проект, может быть предложено присоединиться к команде Sponge руководителями групп по их усмотрению. Формального процесса подачи заявок нет. Пожалуйста, не проситесь в команду, мы сами позовём Вас.

Основные шаги

  1. Настройте ваше рабочее пространство, как описано в статье Подготовка к разработке.
  2. Убедитесь, что знакомы с Git и GitHub. Если нет, посмотрите статью Инструкция по Git(Hub)
  3. Проверьте существущие проблемы в SpongeAPI, SpongeCommon, SpongeForge, SpongeVanilla, и SpongeDocs репозиториях. Возможно, кто-то уже работает над ними. Вы также можете взглянуть на проблемы с пометкой «help wanted» для открытых вопросов, в которых нам необхдима Ваша помощь.

Примечание

Не создавайте pull request для небольших изменений менее 20 линий. Лучше присоединяйтесь к #sponge в IRC (irc.esper.net) или присоединяйтесь к #spongedev в IRC (irc.esper.net) и мы изменим, что вы хотите, вместе с другими небольшими изменениями.

  1. Если проблема требует больших изменений, вы можете сначала представить их без необходимых изменений, так что мы можем зафиксировать решение этой проблемы за вами. Вы также должны заранее создать WIP (Work In Process) pull-запрос с префиксом [WIP] чтобы мы уже могли начать его рассмотрение.
  2. Форкните проект, клонируйте его и внесите изменения в дополнительные ветви.
  3. Протестируйте Ваши изменения (убедитесь, что они компилируются!), сделайте коммит и вытолкните в Ваш форк.
  4. Отправляйте pull request с кратким описанием того, что вы изменили и почему оно должно быть именно таким.
  5. Если вы сделали дополнительные изменения, вытолкните новые коммиты с ними в вашу ветку. Не смешивайте все Ваши изменения, это очень сильно усложняет отслеживание изменений с прошлой версией pull-запроса.
  6. Удостоверьтесь, что ваш PR перебазирован до последних изменений в ветке, которую вы собираетесь объединить. Если вам нужна помощь в перебазировании, просто спросите!

Совет

Если вы не уверены, на какой ветке (branch) Вам следует работать, прочитайте о нашем :doc: versioning перед созданием PR (Pull Request).