Участие

Здравствуйте! Если вы хотите внести свой вклад в Sonic Pi, это замечательно. Мы рады любой помощи!

Хотите узнать о различных способах участия? Смотрите TYPES-OF-CONTRIBUTIONS.md.

Хотите знать обо всех новых функциях, которые мы хотели бы видеть в Sonic Pi? Смотрите доску проектов Sonic Pi (https://github.com/orgs/sonic-pi-net/projects/1).

Понимание исходного кода Sonic Pi

Есть несколько способов узнать больше о технической структуре исходного кода Sonic Pi.

• Вы можете прочитать краткие описания структуры исходного кода и увидеть диаграмму основных компонентов, доступную в разделе «Разработка» на боковой панели вики Sonic Pi (https://github.com/sonic-pi-net/sonic-pi/wiki). Примечание: все они в той или иной степени устарели, и мы находимся в процессе их обновления — поэтому для любого серьёзного использования не стесняйтесь обращаться к нам напрямую.
• Вы можете изучить исходный код в нашем официальном репозитории Sonic Pi GitHub (https://github.com/sonic-pi-net/sonic-pi).
• Вы можете задать вопросы основной команде разработчиков или более широкому сообществу Sonic Pi в любом из мест, где мы собираемся как сообщество (COMMUNITY.md).

Рекомендации по проекту и процессу разработки

Существует несколько рекомендаций, которые мы ценим при планировании формата новой работы. Мы призываем участников сообщества также учитывать их при рассмотрении возможности внести свой вклад в Sonic Pi. Они таковы:

• Мы предпочитаем ограничивать количество различных технологий/фреймворков/языков, используемых в проекте, там, где это возможно.
• Мы отдаём предпочтение дружелюбному, разговорному стилю документации перед формальным языком.
• В соответствии с основными целями проекта мы хотим, чтобы функции Sonic Pi были достаточно простыми для понимания и использования 10-летним ребёнком.
• Мы предпочитаем предложенные вклады, а также технические решения, принятые при их создании, иметь явные преимущества, перевешивающие любые недостатки.
• Мы предпочитаем не вносить потенциальную нестабильность или неопределённость в код, который используется в процессе сборки приложения, если нет действительно веской причины для этого.
• Поскольку проект Sonic Pi в конечном итоге принадлежит @samaaron, все вклады должны быть в форме, соответствующей видению Сэма для проекта, и он сможет понять и поддерживать его, если первоначальный автор уйдёт из проекта.

Также относительно процесса разработки Sonic Pi:

• Мы не устанавливаем сроки разработки.
• Всю текущую работу мы объединяем в ветке dev. Код объединяется в ветку stable для стабильных выпусков.
• Мы хотим, чтобы код, предназначенный для объединения в ветки dev или stable, проходил все тесты, где это возможно.
• При обнаружении новой ошибки желательно как можно скорее создать заявку на проблему (в идеале в течение 48 часов).
• Когда кто-то намеревается начать работу над проблемой или новой функцией:
  • Сначала он проверяет, не собирается ли кто-нибудь ещё (или уже сделал) работать над ней, через страницу «Проблемы» (https://github.com/sonic-pi-net/sonic-pi/issues) или доску проектов функций Sonic Pi (https://github.com/orgs/sonic-pi-net/projects/1)
  • Если проблема или функция свободно доступны для работы, человек, намеревающийся начать над ними работу, упоминает об этом публично где-либо (для проблем, оставляя сообщение в заявке с просьбой назначить её, и для новых функций, упоминая об этом в любом месте, где мы собираемся как сообщество (COMMUNITY.md)).

Идеальный процесс для внесения вклада с помощью кода

1. Ознакомьтесь с частями кода, к которым вы хотите внести вклад, если это необходимо. Мы всегда рады ответить на вопросы о коде Sonic Pi!
2. Для сложных или крупных изменений кода стоит сначала обсудить потенциальные решения с основной командой и другими участниками Sonic Pi — либо открыв проблему и обозначив её как запрос функции, либо снова пообщавшись с нами в любом из мест, где мы собираемся как сообщество (COMMUNITY.md).
3. Создайте копию репозитория Sonic Pi на своём личном аккаунте GitHub.
4. Клонируйте свою вилку на локальный компьютер. 5. Внесите изменения в свой локальный клон Sonic Pi.
5. Зафиксируйте изменения и отправьте их в свою ветку на GitHub.
6. Откройте запрос на включение (Pull Request) в официальный репозиторий Sonic Pi.
7. Если потребуются изменения, либо от ботов, прикреплённых к репозиторию Sonic Pi, либо от основной команды, внесите необходимые изменения и снова отправьте их в вашу ветку на GitHub.
8. После того как ваш код пройдёт проверку, он будет объединён.

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

Примечание: если будет решено, что вклад не будет включён в данный момент, это не означает, что усилия не ценятся! В такой ситуации основная команда постарается предоставить объяснение.