Вклад в проект EdgeX Web UI Golang

Ссылка: Документация по участию в проекте edgex-go

Далее представлен набор рекомендаций по внесению вклада в EdgeX Foundry и его библиотеки, которые размещены в Организации EdgeX Foundry на GitHub.

Этот проект придерживается Кодекса участника 1.2. Ожидается, что вы будете соблюдать этот кодекс.

Сообщение о проблемах

Сообщение о проблемах — это отличный способ внести вклад в проект. Мы всегда ценим хорошо написанные и подробные отчёты об ошибках.

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

Хороший отчёт об ошибке не должен оставлять других людей в ожидании дополнительной информации от вас. Пожалуйста, постарайтесь быть как можно более подробными. Следующие вопросы могут служить шаблоном для написания подробных отчётов:

• Что вы пытались сделать?
• Каковы ожидаемые результаты?
• Какие результаты получены?
• Как воспроизвести проблему?
• В какой среде вы столкнулись с проблемой?

Запросы на вытягивание

Хорошие запросы на вытягивание (например, патчи, улучшения, новые функции) — это огромная помощь. Они должны оставаться в рамках и не содержать несвязанных коммитов.

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

Пожалуйста, придерживайтесь соглашений о кодировании, используемых в проекте. Если вы сомневаетесь, обратитесь к руководству по стилю Effective Go.

Лучший способ включить вашу работу в проект — следовать следующему процессу:

1. Форкните проект, клонируйте свой форк и настройте пульты:

   # Клонируйте ваш форк репозитория в текущий каталог
   git clone https://github.com/<your-username>/edgex-ui-go.git
   
   # Перейдите в только что клонированный каталог
   cd edgex-ui-go
   
   # Назначьте оригинальный репозиторий удалённому под названием «upstream»
   git remote add upstream https://github.com/edgexfoundry/edgex-ui-go.git

2. Если вы клонировали некоторое время назад, получите последние изменения из upstream:

   git checkout master
   git pull --rebase upstream master

3. Создайте новую тематическую ветку из master, используя соглашение об именах EUG-[номер проблемы], чтобы помочь нам отслеживать область вашего вклада:

   git checkout -b EUG-[issue-number]

4. Внесите свои изменения логическими частями. Когда вы будете готовы к фиксации, убедитесь, что написали хорошее сообщение о фиксации™. Обратитесь к руководству по вкладу Erlang, если вы не уверены, что представляет собой хорошее сообщение о фиксации™. Используйте интерактивную перебазировку, чтобы сгруппировать ваши коммиты в логические единицы работы перед их публикацией.

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

   Используйте своё настоящее имя (извините, никаких псевдонимов или анонимных вкладов). Если вы установите свои настройки git user.name и user.email, вы можете автоматически подписать свой коммит с помощью git commit -s.

5. Локально объедините (или перебазируйте) ветку разработки upstream в свою тематическую ветку:

   git pull --rebase upstream master

6. Отправьте свою тематическую ветку в свой форк:

   git push origin EUG-[issue-number]

7. Создайте запрос на вытягивание с чётким заголовком и подробным описанием.