Вклад в JoyQueue

Спасибо за вашу помощь в улучшении проекта!

JoyQueue лицензирован под Apache 2.0 и принимает вклады через запросы на вытягивание (pull requests) на Github. В этом документе описаны некоторые соглашения по сборке, запуску и тестированию, а также рабочий процесс разработки и форматирование сообщений коммитов.

Сборка и настройка рабочего пространства для разработки

Необходимые условия

• Java 1.8 или выше;
• Maven 3.0 или выше;
• Git.

Получение репозитория

git clone git@github.com:chubaostream/joyqueue.git
cd joyqueue

Сборка и тестирование

Пропустить тест и установить

mvn -Dmaven.test.skip=true -PCompileFrontend install

Запустить юнит-тест

mvn test

Запуск JoyQueue

Запуск JoyQueue с одним узлом полезен для разработки и тестирования. После завершения mvn install бинарный пакет (.tar.gz) можно найти в целевом каталоге сервера/веб-модуля joyqueue-distribution. Распакуйте их и запустите сервер и портал JoyQueue соответственно.

• Запустите сервер JoyQueue:

bin/server-start.sh

• Запустите портал JoyQueue:

bin/start.sh

Процесс внесения вклада

Примерное описание процесса внесения вклада:

1. Отправьте или выберите задачу, которую хотите решить.
2. Создайте форк этого репозитория, разработайте и протестируйте изменения кода.
3. Отправьте запрос на вытягивание против основной ветки этого репозитория.
   • Прикрепите номер связанной задачи.
4. Ваш запрос на вытягивание может быть объединён после прохождения всех настроенных проверок, включая:
   • пройденные тесты в CI;
   • проверку как минимум одного сопровождающего.

Коммит

Предпочтительно перебазировать коммиты, чтобы сделать историю коммитов более читаемой.

Сообщения коммитов

Сообщения коммитов должны быть в следующем формате:

• Опишите, что сделано;
• Используйте активный залог;
• Напишите первое слово с заглавной буквы;
• Укажите номер задачи на Github. Примеры:

bad:  A new storage metric
good: Introduce a new storage monitor metric (#34)