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

Добро пожаловать в проект Baetyl Open Source. Чтобы внести вклад в Baetyl, пожалуйста, следуйте процессу ниже.

Мы искренне ценим ваш вклад. Этот документ объясняет нашу рабочую модель и стиль работы.

Процесс работы

Baetyl использует эту модель ветвления Git. Следующие шаги помогут вам внести обычный вклад.

1. Создание форка

   Наша разработочная команда быстро растет, поэтому мы поощряем разработчиков подавать код. И пожалуйста, отправляйте запросы на слияние (Pull Requests) из вашего форка. Чтобы создать форк, пожалуйста, обратитесь к странице Github и нажмите на кнопку "Fork".

2. Подготовка к разработке

   go get github.com/baetyl/baetyl # клонирование официального репозитория Baetyl
   cd $GOPATH/src/github.com/baetyl/baetyl # переход в папку Baetyl
   git checkout master  # проверка ветки master
   git remote add fork https://github.com/<ваш_github_аккаунт>/baetyl  # указание удаленного репозитория

3. Отправка изменений в ваш форк

   git status   # просмотр текущего статуса изменений кода
   git add .    # добавление всех локальных изменений
   git commit -c "изменение описания"  1 # коммит изменений с комментарием
   git push fork # отправка изменений кода в удаленный репозиторий, указывающий на ваш форк

4. Создание запроса на слияние

5. В комментарии к коммиту укажите описание изменений.

Примечание

1. Исправлено: "git commit -c "изменение описания"" на "git commit -c "изменение описания"" с учетом структуры команды. Вы можете отправить запрос на слияние (Pull Request) в официальный репозиторий Baetyl https://github.com/baetyl/baetyl. Чтобы создать запрос на слияние, пожалуйста, следуйте этим шагам. Как только рецензент официального репозитория Baetyl одобрит и объединит ваш запрос на слияние, вы увидите код, внесённый вами, в официальном репозитории Baetyl.## Рецензирование кода — О форматировании кода на Golang, пожалуйста, обратитесь к Go Code Review Comments.

• Пожалуйста, не стесняйтесь отправлять URL вашего pull request на почту вашим рецензентам. Пожалуйста, делайте это после того, как ваш pull request пройдет CI.
• Пожалуйста, отвечайте на каждый комментарий рецензентов. Если вы следуете комментарию, пожалуйста, напишите "Выполнено"; в противном случае укажите причину.
• Если вы не хотите, чтобы рецензенты были перегружены уведомлениями по электронной почте, вы можете ответить на их комментарии в одном пакете.
• Уменьшите ненужные коммиты. Некоторые разработчики часто делают коммиты. Рекомендуется объединять последовательность небольших изменений в один коммит, используя git commit --amend вместо git commit.

Правило слияния

• Перед отправкой изменений необходимо выполнить команду make test (должны быть включены юнит-тесты), и убедиться, что все юнит-тесты и тесты на гонку данных прошли успешно.
• Только прошедший тестирование (юнит-тесты и тесты на гонку данных) код может быть отправлен в официальный репозиторий Baetyl.
• Код может быть слит в официальный репозиторий Baetyl только после одобрения хотя бы одного рецензента.

Примечание: Правила внесения вклада в документы соответствуют вышеуказанным правилам.