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

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

Сертификат происхождения

Внося вклад в этот проект, вы соглашаетесь с сертификатом разработчика о происхождении (Developer Certificate of Origin, DCO). Этот документ был создан сообществом Linux Kernel и представляет собой простое заявление о том, что вы, как участник, имеете законное право вносить свой вклад. Подробнее см. в файле DCO.

Электронная почта и чат

Проект в настоящее время использует общий список рассылки CoreOS и IRC-канал:

• Электронная почта: coreos-dev
• IRC: #coreos, IRC-канал на freenode.org

Пожалуйста, не отправляйте электронные письма напрямую сопровождающим, указанным в файле MAINTAINERS. Они очень заняты и читают списки рассылки.

Начало работы

• Создайте форк репозитория на GitHub
• Прочитайте файл README для получения инструкций по сборке и тестированию
• Поиграйте с проектом, сообщайте об ошибках, предлагайте патчи!

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

Это примерный план рабочего процесса участника:

• Создайте тематическую ветку, от которой будет основана ваша работа (обычно master).
• Делайте коммиты логических единиц.
• Убедитесь, что ваши сообщения коммитов имеют правильный формат (см. ниже).
• Отправьте свои изменения в тематическую ветку в своём форке репозитория.
• Проверьте, проходят ли тесты, и добавьте новые тесты при необходимости.
• Отправьте запрос на вытягивание в оригинальный репозиторий.

Спасибо за ваш вклад!

Стиль кодирования

Проекты CoreOS, написанные на Go, следуют набору рекомендаций по стилю, которые мы задокументировали здесь. Пожалуйста, следуйте им при работе над своими вкладами.

Формат сообщения коммита

Мы следуем условному соглашению для сообщений коммитов, которое предназначено для ответа на два вопроса: что изменилось и почему. В строке темы должно быть указано «что», а тело коммита должно описывать «почему».

scripts: add the test-cluster command

this uses tmux to setup a test cluster that you can easily kill and
start for debugging.

Fixes #38

Формально формат можно описать следующим образом:

<subsystem>: <что изменилось>
<BLANK LINE>
<почему было сделано это изменение>
<BLANK LINE>
<footer>

Первая строка — это тема, она должна быть не длиннее 70 символов, вторая строка всегда пустая, а остальные строки должны переноситься на 80 символов. Это позволяет сообщению легче читаться на GitHub, а также в различных инструментах git.