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

Мы всегда рады новым участникам, будь то небольшие доработки или крупные новые функции.

Нам нужны высококачественные и хорошо документированные коды для каждого языка программирования, а также окружающая экосистема интеграционных инструментов, которые люди используют с RocketMQ.

Но код — не единственный способ внести свой вклад в проект. Мы высоко ценим документацию, интеграцию с другими проектами и с радостью принимаем улучшения в этих аспектах.

Рекомендуем прочитать:

• Техническое руководство для участников.
• Примите участие!.

Внесение кода

Чтобы предложить изменение для включения, пожалуйста, сделайте следующее:

Если изменение нетривиально, включите несколько модульных тестов, покрывающих новую функциональность.

Если вы предлагаете совершенно новую функцию или API, рекомендуется начать с РИП и сначала получить согласие по основному дизайну.

Наша задача — своевременно отслеживать патчи. Напомните нам, если мы не выполняем свою работу (иногда мы что-то упускаем).

Сжатие коммитов

Если у вас есть запрос на вытягивание на GitHub, и вы обновляли его более одного раза, лучше всего сжать все коммиты.

1. Определите, сколько коммитов вы сделали с начала работы: git log.
2. Сожмите эти коммиты до N: git rebase -i HEAD~N .
3. Оставьте тег «pick» в первой строке.
4. Измените все остальные коммиты с «pick» на «fixup».
5. Затем выполните «принудительный толчок», чтобы перезаписать удалённую историю: git push -u origin ROCKETMQ-9999 --force
6. Все ваши изменения теперь находятся в одном коммите, что значительно облегчит проверку.

Более подробную информацию о сжатии можно найти на stackoverflow.

Стать коммиттером

Мы всегда заинтересованы в привлечении новых участников. То, что мы ищем, — это серия вкладов, хороший вкус и постоянный интерес к проекту. Если вы заинтересованы стать коммиттером, сообщите об этом одному из существующих коммиттеров, и они помогут вам пройти через этот процесс.

В настоящее время у нас есть несколько важных точек вклада:

Wiki & JavaDoc

RocketMQ SDK (C++.Net\Php\Python\Go\Node.js)

Коннекторы RocketMQ

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

Если вы хотите внести вклад в вышеперечисленные пункты, вы должны соблюдать некоторые предварительные условия:

Читаемость — API должен иметь Javadoc, некоторые очень важные методы также должны иметь javadoc.

Тестируемость — покрытие модульными тестами основного процесса составляет 80% и выше.

Удобство сопровождения — соответствие нашему спецификации checkstyle, и частота обновлений не менее 3 месяцев.

Возможность развёртывания — мы рекомендуем вам развернуть в репозитории maven.