Обзор

В проектах RabbitMQ для обсуждения, совместной работы и принятия вкладов кода используются запросы на вытягивание (pull requests). Запросы на вытягивание являются основным местом для обсуждения изменений в коде.

Как внести вклад

Процесс является довольно стандартным:

• Форкните репозиторий или репозитории, в которые вы планируете внести свой вклад.
• Выполните команду bazel sync, если вы планируете использовать Bazel, или make.
• Создайте ветку с описательным именем в соответствующих репозиториях.
• Внесите изменения, запустите тесты, убедитесь в правильном форматировании кода, выполните фиксацию с помощью описательного сообщения, отправьте изменения в свою форк.
• Отправьте запросы на вытягивание с объяснением того, что было изменено и почему.
• При необходимости предоставьте заполненное и подписанное Соглашение о сотрудничестве (см. ниже).
• Будьте терпеливы. Мы обязательно рассмотрим ваш запрос на вытягивание.

Если вы собираетесь работать над существенными изменениями, сначала спросите мнение основной команды на списке рассылки RabbitMQ.

Запуск тестов

См. это руководство по использованию Bazel и BuildBuddy для разработки ядра RabbitMQ.

Работа над пользовательским интерфейсом управления с BrowserSync

При работе над кодом пользовательского интерфейса управления, помимо запуска узла с помощью команды

bazel run broker RABBITMQ_ENABLED_PLUGINS=rabbitmq_management

(или любого другого набора плагинов), настоятельно рекомендуется использовать BrowserSync для сокращения цикла редактирования/обратной связи для файлов JS, CSS и т. д.

Сначала установите BrowserSync с помощью NPM:

npm install -g browser-sync

Предполагая, что локально запущен узел с HTTP API на порту 15672, запустите прокси BrowserSync следующим образом:

cd deps/rabbitmq_management/priv/www
browser-sync start --proxy localhost:15672 --serverStatic . --files .

BrowserSync автоматически откроет окно браузера для использования. Окно будет автоматически обновляться при изменении одного из статических файлов (шаблоны, JS, CSS).

Все HTTP-запросы, которые BrowserSync не знает, как обработать, будут перенаправлены на HTTP API по адресу localhost:15672.

Форматирование CLI RabbitMQ

CLI RabbitMQ использует стандартный форматировщик кода Elixir. Чтобы обеспечить правильное форматирование кода в CLI:

cd deps/rabbitmq_cli
mix format

Выполнение команды make проверит форматирование CLI и выдаст необходимые предупреждения. В качестве альтернативы можно запустить проверку формата в каталоге deps/rabbitmq_cli:

mix format --check-formatted

Кодекс поведения

Смотрите CODE_OF_CONDUCT.md.

Соглашение о сотрудничестве

Если вы хотите внести нетривиальное изменение, пожалуйста, предоставьте подписанную копию нашего Соглашения о сотрудничестве, примерно в то же время, когда вы отправляете свой запрос на вытягивание. Это значительно упростит (в некоторых случаях сделает возможным) для команды RabbitMQ в Pivotal объединение вашего вклада.

Где задавать вопросы

Если что-то непонятно, не стесняйтесь спрашивать на нашем списке рассылки и Slack сообщества.