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

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

Примечание

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

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

1. Setup your workspace as described in Подготовка к разработке.

2. Убедитесь, что знакомы с Git и GitHub. Если нет, посмотрите статью Инструкция по Git(Hub)

3. Проверьте наличие существующих проблем в репозиториях SpongeAPI, SpongeCommon и SpongeDocs. Возможно, кто-то уже работает над тем-же самым. Вы также можете проверить существующие вопросы, отмеченные как «help wanted» (требуется помощь), в которых нам нужна ваша помощь.

Примечание

Please don’t submit pull requests for small, non-functional changes such as fixing typos or renaming variable names. Instead, you can:

• join #spongedev on IRC (irc.esper.net) and we’ll change it together with the other smaller changes.

• Join our Discord Server and post on the #dev channel. Discord and IRC are linked, so don’t worry. We won’t miss your message!

• You can also add it to our list of Minor Issues on GitHub.

4. If the issue requires a bigger change you may want to submit the issues without the necessary changes first, so we can confirm the issue and know that you’re working on fixing it. You should also create a draft pull request or comment with ~wip so we can already start reviewing them.

5. Форкните проект, клонируйте его и внесите изменения в дополнительные ветви.

6. Протестируйте Ваши изменения (убедитесь, что они компилируются!), сделайте коммит и вытолкните в Ваш форк.

7. Отправляйте pull request с кратким описанием того, что вы изменили и почему оно должно быть именно таким.

8. Если вы сделали дополнительные изменения, вытолкните новые коммиты с ними в вашу ветку. Не смешивайте все Ваши изменения, это очень сильно усложняет отслеживание изменений с прошлой версией pull-запроса.

9. Удостоверьтесь, что ваш PR перебазирован до последних изменений в ветке, которую вы собираетесь объединить. Если вам нужна помощь в перебазировании, просто спросите!

Совет

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