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

Спасибо всем, кто вносит свой вклад в Service-Center.

В этом документе объясняется процесс и лучшие практики для отправки Pull Request в проект Service-Center. Этот документ можно рассматривать как справочное руководство для всех участников и он будет полезен новым и нечастым участникам.

Клонирование репозитория и размещение его в $GOPATH

Клонируйте репозиторий в соответствующий GOPATH:

git clone https://github.com/apache/servicecomb-service-center.git $GOPATH/src/github.com/apache/servicecomb-service-center
cd $GOPATH/src/github.com/apache/servicecomb-service-center

Загрузка зависимостей

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

curl https://glide.sh/get | sh
glide install

Внесение изменений

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

Компиляция и запуск теста локально

После того как вы внесли изменения, пожалуйста, следуйте приведённым ниже проверкам, чтобы обеспечить качество кода перед созданием PR.

go fmt ./...

go build -o service-center

Запуск UT в локальной среде, этот шаг предполагает, что у вас запущен docker в вашей среде.

bash -x scripts/ut_test_in_docker.sh 

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

bash -x scripts/integration_test.sh

Отправка кода и создание PR

После компиляции, UT и IT вы готовы к созданию PR, пожалуйста, следуйте этим инструкциям для создания PR.