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

Вы приветствуем ваш вклад в проект BFE. Чтобы внести свой вклад в BFE, вам необходимо согласиться с Соглашением о лицензии участника.

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

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

BFE использует эту модель управления ветками Git. Ниже представлены шаги для обычных вкладов.

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

   Наше сообщество разработчиков быстро развивается; поэтому нет смысла для всех писать непосредственно в официальный репозиторий. Поэтому, пожалуйста, отправляйте запросы на слияние ("pull requests") из вашего форка. Для создания форка просто перейдите на страницу GitHub и нажмите кнопку "Fork".

2. Клонирование

   Чтобы создать локальную копию вашего форка на своем компьютере, выполните следующие команды:

   git clone https://github.com/ваш-аккаунт-github/bfe
   cd bfe

3. Создание локальной ветки функциональности

   Для ежедневной работы, такой как добавление новой функциональности или исправление ошибок, откройте свою ветку перед началом кодирования:

   git checkout -b моя-крутая-функциональность

4. Коммит

   Перед тем как использовать первую команду git commit, установите pre-commit с помощью следующих команд: ```bash pip install pre-commit pre-commit install

   
   Настройка `pre-commit` требует использования `gofmt` для автоматического форматирования кода на Go.
   
   После установки `pre-commit` проверяет стиль кода и документации при каждом коммите:
   

   $ git commit

   
   **Примечание:** Установленная версия `yapf` через `pip install pre-commit` и `conda install -c conda-forge pre-commit` немного отличается. Разработчики BFE используют `pip install pre-commit`.
   

5. Сборка и тестирование

   Пользователи могут собирать BFE непосредственно на Linux.

   make

6. Обновление

   Опытный пользователь Git часто выполняет команду pull от официального репозитория — ежедневно или даже несколько раз в час, чтобы своевременно замечать конфликты с работами других людей и легче решать меньшие конфликты.

   git remote add upstream https://github.com/bfenetworks/bfe
   git pull upstream develop

7. Отправка и создание запроса на слияние

   Вы можете отправить ваш локальный вклад в ваш форк:

   git push origin мою-крутую-функциональность

   Отправка позволяет создать запрос на слияние, который просит владельцев этого официального репозитория слить ваши изменения в основной репозиторий. Чтобы создать запрос на вытягивание, пожалуйста, следуйте этим шагам.Если ваша правка направлена на исправление проблемы, пожалуйста, напишите "Исправляет <адрес-проблемы>" в разделе описания вашего запроса на слияние. GitHub закроет проблему после того, как владельцы примут ваш запрос на слияние.Пожалуйста, запомните, чтобы указать некоторых рецензентов для вашего запроса на вытягивание. Если вы не знаете, кто правильные люди, пожалуйста, следуйте рекомендациям GitHub.

Удаление локальных и удалённых веток

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

git push origin :my-cool-stuff
git checkout develop
git pull upstream develop
git branch -d my-cool-stuff

Обзор кода

• Пожалуйста, не стесняйтесь связаться с рецензентами, отправив им URL вашего запроса на вытягивание через мессенджер или электронной почтой. Пожалуйста, делайте это после прохождения CI вашего запроса на вытягивание.

• Пожалуйста, отвечайте на каждый комментарий рецензентов. Если вы следуете комментарию, пожалуйста, пишите "Выполнено". Пожалуйста, дайте причину, если нет.

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

• Уменьшите ненужные коммиты. Некоторые разработчики часто коммитят изменения. Рекомендуется объединять последовательность маленьких изменений в один коммит, используя git commit --amend, вместо использования git commit.

Кодирование стандартов### Стиль кода

Наш код на Go следует руководству по стилю Go.

Процесс сборки помогает проверять стиль кода.

Пожалуйста, установите pre-commit, который автоматически реформатирует изменения в коде на Go при каждом выполнении git commit.

Единичные тесты

Пожалуйста, добавьте связанные единичные тесты.

• Для кода на Go, пожалуйста, используйте стандартный пакет testing Go.