Руководство по вкладу

Мы приветствуем вклад в проект Arduino ESP32!

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

Вклад в Arduino ESP32 - исправление ошибок, добавление функций, добавление документации - приветствуется. Мы принимаем вклад через Pull Requests на Github.

Перед внесением вклада

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

• Является ли вклад полностью вашей собственной работой или уже лицензирован под совместимой с LGPL 2.1 Open Source Лицензией? Если нет, то, к сожалению, мы не можем принять его.
• Достаточно ли код прокомментирован для понимания его структуры?
• Есть ли документация или примеры, сопровождающие вклады в код?
• Написаны ли комментарии и документация на чистом английском языке, без орфографических или грамматических ошибок?
• Примеры вкладов также приветствуются.
• Если вклад содержит несколько коммитов, объединены ли они в логические изменения (одно основное изменение на один Pull Request)? Слишком ли мелкие коммиты, такие как "исправлена опечатка", слияются с предыдущими коммитами?
• Если вы не уверены в каких-либо из этих пунктов, пожалуйста, всё равно откройте Pull Request и попросите нас дать обратную связь.

Процесс Pull Request

После того как вы откроете Pull Request, скорее всего, будет некоторое обсуждение в комментариях к запросу.

Когда Pull Request будет готов к слиянию, он сначала будет объединён в нашу внутреннюю систему git для автоматизированного тестирования внутри компании.

Если этот процесс пройдёт успешно, он будет объединён в публичный репозиторий на github.

Юридическая часть

Прежде чем вклад может быть принят, вам необходимо подписать наш :doc:`contributor-agreement`. Вы будете автоматически приглашены к этому в рамках процесса Pull Request.

Связанные документы

.. toctree::
    :maxdepth: 1

        contributor-agreement