Руководство по внесению вклада

Благодарим вас за интерес к Dapr!

Этот проект приветствует вклады и предложения. Большинство вкладов требуют от вас подписания ваших коммитов через Сертификат разработчика (Developer Certificate of Origin, DCO). Когда вы отправляете запрос на вытягивание, бот DCO автоматически определяет, нужно ли вам предоставить подпись для вашего коммита. Пожалуйста, следуйте инструкциям бота DCO, так как запросы на вытягивание не могут быть объединены до тех пор, пока автор(ы) не предоставят подпись, чтобы выполнить требование DCO. Вы можете найти дополнительную информацию о требованиях DCO ниже.

В этом проекте принят Кодекс поведения участников сообщества.

Вклады бывают разных форм: отправка проблем, написание кода, участие в обсуждениях и звонках сообщества.

Данный документ содержит рекомендации по тому, как внести вклад в проект Dapr.

Проблемы

В данном разделе описаны рекомендации по отправке проблем.

Типы проблем

Существует 4 типа проблем:

• Проблема/Ошибка: Вы обнаружили ошибку в коде и хотите сообщить о ней или создать проблему для отслеживания ошибки.
• Проблема/Обсуждение: У вас есть что-то на уме, что требует ввода данных от других в обсуждении, прежде чем это в конечном итоге проявится в виде предложения.
• Проблема/Предложение: Используется для элементов, которые предлагают новую идею или функциональность. Это позволяет получить обратную связь от других до написания кода.
• Проблема/Вопрос: Используйте этот тип проблемы, если вам нужна помощь или у вас есть вопрос.

Прежде чем отправить

Прежде чем отправить проблему, убедитесь, что вы проверили следующее:

1. Правильно ли выбран репозиторий?
   • Проект Dapr распределён по нескольким репозиториям. Проверьте список репозиториев, если вы не уверены, какой из них является правильным.
2. Проверка существующих проблем
   • Прежде чем создавать новую проблему, пожалуйста, выполните поиск в открытых проблемах, чтобы увидеть, была ли проблема или запрос функции уже подан.
   • Если вы обнаружите, что ваша проблема уже существует, добавьте соответствующие комментарии и добавьте свою реакцию. Используйте реакцию:
     • 👍 проголосовать
     • 👎 проголосовать против
3. Для ошибок
   • Убедитесь, что это не проблема среды. Например, при работе в Kubernetes убедитесь, что предварительные условия выполнены. (хранилища состояний, привязки и т. д.)
   • У вас имеется как можно больше данных. Обычно это происходит в форме журналов и/или трассировки стека. Если вы работаете в Kubernetes или другой среде, посмотрите журналы служб Dapr (среда выполнения, оператор, служба размещения). Более подробную информацию о том, как получить журналы, можно найти здесь.
4. Для предложений
   • Многие изменения в среде выполнения Dapr могут потребовать изменений в API. В этом случае лучшим местом для обсуждения потенциальной функции является основной репозиторий Dapr.
   • Другие примеры могут включать привязки, хранилища состояний или совершенно новые компоненты.

Внесение вклада в Dapr

В данном разделе описываются рекомендации по внесению кода / документации в Dapr.

Запросы на вытягивание

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

1. Убедитесь, что есть проблема (ошибка или предложение), которая устанавливает ожидания для вклада, который вы собираетесь сделать.
2. Форкните соответствующий репозиторий и создайте новую ветку
3. Внесите свои изменения
   • Изменения кода требуют тестов
4. Обновите соответствующую документацию для изменения
5. Зафиксируйте с [подписью DCO](#сертификат разработчика подписание вашей работы) и откройте PR
6. Дождитесь завершения процесса CI и убедитесь, что все проверки зелёные
7. Будет назначен сопровождающий проекта, и вы можете ожидать рассмотрения в течение нескольких дней

Используйте рабочие запросы на вытягивание для получения ранней обратной связи

Хороший способ общения перед тем, как вкладывать слишком много времени, — это создать «рабочий» PR и поделиться им со своими рецензентами. Стандартный способ сделать это — добавить префикс «[WIP]» в Заголовок вашего PR и присвойте ему метку do-not-merge. Это даст понять тем, кто просматривает ваш PR, что он ещё недостаточно проработан.

Сертификат разработчика о происхождении: подписывайте свои работы

Каждый коммит должен быть подписан

Сертификат разработчика о происхождении (Developer Certificate of Origin, DCO) — это простой способ для участников подтвердить, что они написали код или имеют право отправить его в проект. Вот полный текст DCO, переформатированный для удобства чтения:

«Внося вклад в этот проект, я подтверждаю, что:

• (a) Вклад полностью или частично создан мной, и у меня есть право отправить его под открытой лицензией, указанной в файле;
• (b) Вклад основан на предыдущей работе, которая, насколько мне известно, подпадает под соответствующую открытую лицензию, и у меня есть право отправлять эту работу с изменениями, созданными полностью или частично мной, под той же открытой лицензией (если только мне не разрешено отправлять её под другой лицензией), как указано в файле;
• (c) Вклад был предоставлен мне непосредственно другим лицом, которое подтвердило пункты (а), (б) или (в), и я не вносил в него изменений.
• (d) Я понимаю и согласен с тем, что этот проект и вклад являются публичными, и что запись о вкладе (включая всю личную информацию, которую я отправляю вместе с ним, включая мою подпись) хранится бесконечно и может быть распространена в соответствии с этим проектом или задействованными открытыми лицензиями».

Участники подтверждают своё согласие с этими требованиями, добавляя строку Signed-off-by в сообщения о коммитах.

Это моё сообщение о коммите
Signed-off-by: Random J Developer <random@developer.example.org>

У Git даже есть опция командной строки -s, чтобы автоматически добавлять это к вашему сообщению о коммите:

$ git commit -s -m 'Это моё сообщение о коммите'

Каждый запрос на вытягивание проверяется на наличие действительной строки Signed-off-by в коммитах запроса на вытягивание.

Я не подписал свой коммит, что теперь?!

Не беспокойтесь — вы можете легко воспроизвести свои изменения, подписать их и принудительно отправить!

git checkout <имя-ветки>
git commit --amend --no-edit --signoff
git push --force-with-lease <имя-удаленного> <имя-ветки>

Использование стороннего кода

— Сторонний код должен включать лицензии.

Спасибо! Ваши вклады в открытый исходный код, большие или маленькие, делают возможными такие проекты. Спасибо, что нашли время внести свой вклад.

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

Этот проект принял Кодекс поведения Contributor Covenant Code of Conduct.