Перейти к содержимому
Последнее обновление

Руководство для участников сообщества

Apache Doris приглашает разработчиков, пользователей, технических писателей, докладчиков и организаторов сообществ со всего мира. Вы можете внести вклад в разработку кода, создание материалов или развитие сообщества. Каждое из этих направлений помогает проекту расти и позволяет участникам публично продемонстрировать свой вклад в совместную работу над открытым исходным кодом.

Разработка кода

Кому подойдёт: участникам, которые хотят непосредственно заниматься разработкой Doris.

  • Исправляйте ошибки и создавайте новые функции.
  • Повышайте производительность, стабильность и наблюдаемость.
  • Добавляйте модульные, регрессионные и интеграционные тесты.
  • Совершенствуйте сборку, CI, выпуск релизов, инструменты разработки и рабочие процессы.
  • Проводите ревью PR и добавляйте техническую документацию, пользовательскую документацию или примеры.

После принятия ваших изменений вы становитесь Contributor проекта Apache Doris.

Перейти к руководству ->

Создание материалов

Кому подойдёт: участникам, которые знакомы со сценариями использования Doris и хотят поделиться практическим опытом.

  • Пишите технические статьи и рассказывайте об использовании Doris в промышленной эксплуатации.
  • Создавайте руководства для начинающих и рекомендации по работе.
  • Записывайте видео о функциях, развёртывании, настройке производительности и устранении неполадок.
  • Выступайте на митапах, вебинарах и конференциях.
  • Переводите документацию, статьи, материалы мероприятий или субтитры к видео.

За качественные материалы участники получают сувениры сообщества в знак благодарности.

Перейти к руководству ->

Развитие сообщества

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

  • Отвечайте на вопросы в Slack, GitHub и списках рассылки.
  • Помогайте новым пользователям находить подходящую документацию, примеры и каналы сообщества.
  • Организуйте онлайн- и офлайн-митапы, практические занятия, открытые консультации или выступления пользователей.
  • Приглашайте пользователей делиться опытом промышленной эксплуатации и миграции.
  • Собирайте отзывы пользователей и передавайте их в публичные каналы сообщества.

Активные участники получают сувениры сообщества в знак благодарности.

Перейти к руководству ->

Преимущества

В зависимости от характера, качества и регулярности вашего вклада вы можете получить:

  • Публичное признание в каналах сообщества Apache Doris.
  • Упоминание в списках участников проекта, благодарностях сообщества или обзорах мероприятий.
  • Возможность публиковать материалы на сайте Apache Doris, в блоге, социальных сетях или на видеоканалах.
  • Возможность выступать на мероприятиях сообщества.
  • Больше возможностей общаться с сопровождающими проекта, Committer, членами PMC и опытными пользователями.
  • Приоритетный доступ к отдельным митапам, вебинарам, тематическим секциям конференций и другим программам сообщества.
  • Публичное подтверждение технического вклада и личного влияния на проект.
  • Сувениры сообщества, памятные вещи или особые подарки.

Участников, которые регулярно вносят качественный технический вклад, сообщество может пригласить стать Committer или членами PMC проекта Apache Doris в соответствии с принятой в Apache процедурой управления проектом. Кроме того, на Doris Summit каждый год выбирают выдающихся героев сообщества, чтобы поблагодарить пользователей, разработчиков и популяризаторов сообщества за значительный вклад.

Руководство по участию в сообществе​

В разделах ниже описано, с чего начать в каждом направлении.

Совет

Это руководство может меняться по мере развития процессов сообщества. Присоединяйтесь к сообществу Apache Doris в Slack, чтобы узнавать о последних изменениях.

Где искать задачи​

Возможности для участия можно найти здесь:

  • Slack: задавайте вопросы, начинайте обсуждения, уточняйте контекст и находите нужных собеседников.
  • Apache Doris GitHub Issues: подходит для сообщений об ошибках, запросов новых функций, идей по улучшению и поиска открытых задач.
  • Apache Doris GitHub Discussions: подходит для технических обсуждений, вопросов по использованию и предложений по проектированию.
  • Дорожная карта: подходит для долгосрочной технической работы. Обычно её можно найти в закреплённой Issue на странице GitHub Issues.
  • Открытые PR: здесь можно помочь с ревью, тестированием, проверкой изменений или продвижением PR к слиянию.

Новые участники могут начать с небольших, чётко ограниченных задач: исправить документацию, добавить тесты, устранить простую ошибку, воспроизвести проблему из Issue, улучшить сообщение об ошибке или привести в порядок пример. Для крупных функций или изменений поведения начните обсуждение в канале #dev сообщества Apache Doris в Slack и попросите ключевых сопровождающих проекта пояснить контекст.

Требования к изменениям кода​

Перед отправкой кода постарайтесь сделать следующее:

  • Создайте форк репозитория apache/doris и отдельную ветку от актуального состояния основной ветки.
  • Посвящайте каждый PR одной конкретной проблеме. Избегайте объединения несвязанных изменений в одном PR.
  • Укажите в заголовке и описании PR цель, объём изменений и способы проверки.
  • Добавьте ссылку на связанную Issue, Discussion или ветку обсуждения в списке рассылки.
  • Добавьте необходимые модульные и регрессионные тесты или шаги ручной проверки.
  • Обновите документацию, если изменение затрагивает поведение, с которым сталкиваются пользователи, конфигурацию, семантику SQL, сообщения об ошибках или совместимость.
  • Укажите в описании PR риски, связанные с совместимостью, производительностью, стабильностью или изменением поведения.

Хороший PR обычно включает:

  • Контекст: зачем нужно изменение.
  • Подход: что изменилось и почему.
  • Тесты: какие тесты или проверки были выполнены и каковы результаты.
  • Риски: влияет ли изменение на совместимость, производительность, стабильность или поведение, с которым сталкиваются пользователи.
  • Документация: нужна ли она и где была обновлена.

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

  • Используйте достаточно мощные модели для разработки, отладки и ревью. Не полагайтесь на сгенерированный код низкого качества при внесении важных изменений.
  • Вы несёте ответственность за отправленный код. Сообщество не принимает код, сгенерированный ИИ, если за него не отвечает человек.

Стандартный процесс слияния​

Изменения кода обычно проходят следующие этапы:

  1. Участник открывает Pull Request.
  2. Committer или участник с более широкими правами запускает CI и AI Review. За помощью можно обратиться в канал #dev в Slack.
  3. Участник исправляет проблемы сборки, тестов или форматирования, выявленные CI и при ревью. Замечания ИИ также являются частью процесса ревью. Применяйте полезные рекомендации и поясняйте в PR, если какая-либо рекомендация неприменима.
  4. При необходимости участник выполняет rebase на актуальное состояние основной ветки и разрешает конфликты.
  5. Все обязательные проверки CI завершаются успешно.
  6. Ревьюер одобряет PR.
  7. Committer выполняет слияние.

Для слияния PR все обязательные проверки CI должны завершиться успешно. Необязательные проверки не блокируют слияние.

Как продвигать процесс ревью​

Участникам следует активно продвигать собственные PR, а не ждать действий ревьюеров. Руководство по участию в Apache Doris также рекомендует участникам выступать модераторами собственных PR и помогать проводить их от отправки до слияния.

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

  • Предоставляйте ревьюерам достаточно контекста в описании PR.
  • Делитесь ссылкой на PR в канале #dev в Slack и просите провести ревью.
  • Своевременно отвечайте на замечания ревьюеров.
  • Отмечайте замечания как решённые после их устранения.
  • Если вы не согласны с замечанием, приводите технические аргументы.
  • Регулярно выполняйте rebase, чтобы конфликты не накапливались надолго.
  • Если работа над PR остановилась, вежливо напомните о нём соответствующим ревьюерам в самом PR.
  • Если вы не знаете, кто должен провести ревью PR, попросите в Slack помочь найти ответственного за нужный модуль.

Способы найти подходящих ревьюеров:

  • Посмотрите недавно принятые PR в том же модуле.
  • Изучите историю коммитов связанных файлов.
  • Посмотрите предложенных GitHub ревьюеров или CODEOWNERS, если они доступны.
  • Попросите в Slack помочь найти подходящего ревьюера, но обязательно перенесите важные технические выводы в GitHub или список рассылки.

Кодекс поведения сообщества​

Всем участникам следует соблюдать следующие принципы:

  • Уважайте других и общайтесь профессионально, доброжелательно и конструктивно.
  • По возможности проводите важные технические обсуждения и принимайте решения сообщества в публичных каналах.
  • Будьте открыты к ревью кода, документации и других материалов.
  • Если вы не согласны с замечаниями ревьюеров, чётко объясняйте свои технические доводы.
  • Не принимайте решения сообщества в частном порядке, если их следует обсуждать публично.
  • Отправляйте оригинальные материалы или явно указывайте источники цитат и заимствованной информации.
  • Избегайте преувеличенных, непроверяемых или вводящих в заблуждение утверждений о производительности и бизнес-результатах.
  • По возможности добавляйте тесты для изменений кода.
  • Обновляйте документацию, если изменение затрагивает поведение, видимое пользователям.
  • Не раскрывайте личные данные пользователей, конфиденциальные сведения клиентов или внутреннюю конфиденциальную информацию компаний.
  • Соблюдайте принципы ответственного раскрытия сведений об уязвимостях. Не публикуйте подробности в открытых каналах до устранения проблемы.
  • Уважайте ценности сообщества Apache и соблюдайте Кодекс поведения ASF.

Участники действуют как члены сообщества открытого исходного кода. Если в каких-либо мероприятиях вы представляете компанию, сообщайте об этом, когда это имеет значение. При этом сам вклад должен соответствовать открытому и прозрачному подходу Apache, в котором ценится вклад каждого участника.

Report issue