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

Спасибо, что нашли время внести свой вклад! HugeGraph — это проект с открытым исходным кодом, и мы будем рады получить вклад от каждого. Мы благодарны всем участникам.

Вот руководство по внесению вклада в HugeGraph:

1. Подготовка

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

Прежде чем отправлять код, необходимо выполнить некоторую подготовку:

1. Зарегистрируйтесь или войдите на GitHub: https://github.com.

2. Форкните репозиторий HugeGraph на GitHub: https://github.com/hugegraph/hugegraph/fork.

3. Клонируйте код из форка репозитория на локальный компьютер: https://github.com/${GITHUB_USER_NAME}/hugegraph.

# клонируем код с удалённого на локальное репо
git clone https://github.com/${GITHUB_USER_NAME}/hugegraph

4. Настройте локальное репозиторий HugeGraph.

cd hugegraph

# добавляем апстрим для синхронизации последнего кода
git remote add hugegraph https://github.com/hugegraph/hugegraph

# устанавливаем имя и адрес электронной почты для отправки кода на github
git config user.name "{полное имя}" # например, «Джерми Ли»
git config user.email "{адрес электронной почты на github}" # например, jermy@gmail.com

5. Подпишите HugeGraph CLA: https://cla-assistant.io/hugegraph/hugegraph.

Необязательно: вы можете использовать Github desktop, чтобы значительно упростить процесс фиксации и обновления.

2. Создайте проблему на GitHub

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

3. Внесите изменения в код локально

3.1 Создайте новую ветку

Пожалуйста, не используйте основную ветку для разработки. Вместо этого мы должны создать новую ветку:

# проверяем основную ветку
git checkout master
# извлекаем последний код из официального hugegraph
git pull hugegraph
# создаём новую ветку: bugfix-branch
git checkout -b bugfix-branch

3.2 Измените код

Предположим, нам нужно изменить некоторые файлы, такие как «HugeGraph.java» и «HugeFactory.java»:

# модифицируем код для исправления ошибки
vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java
vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java
# запускаем тест локально (необязательно)
mvn test -Pcore-test,memory

Примечание: Чтобы легко соответствовать стилю кода, если вы используете IDEA в качестве IDE, вы можете напрямую импортировать наш файл конфигурации стиля кода configuration file.

3.3 Зафиксируйте изменения в git-репозитории

После завершения работы над кодом отправьте его в локальный git-репозиторий:

# добавляем файлы в локальный индекс git
git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java
git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java
# фиксируем изменения в локальном git-репозитории
git commit

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

Fix bug: run deploy multiple times 

fix #ISSUE_ID

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

3.4 Отправьте фиксацию в GitHub fork-репозиторий

Отправьте локальную фиксацию в форк-репозиторий GitHub:

# отправляем локальную фиксацию в fork-репозиторий
git push origin bugfix-branch:bugfix-branch

4. Создайте запрос на вытягивание

Перейдите на веб-страницу форк-репозитория GitHub, там будет возможность создать запрос на вытягивание после отправки в новую ветку, просто нажмите кнопку «Сравнить и запросить вытягивание», чтобы сделать это. Затем отредактируйте описание предлагаемых изменений, которое можно просто скопировать из сообщения фиксации.

5. Проверка кода

Сопровождающие начнут проверку кода после прохождения всех автоматических проверок:

• Проверка: подписано Contributor License Agreement.
• Проверка: сборки Travis CI пройдены (автоматически тестируются и... Коммит будет принят и объединён, если после проверки не обнаружится проблем.

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

Если есть непройденные этапы проверки или запрошенные изменения, продолжайте модифицировать код и отправьте его снова.

6. Дальнейшие изменения после проверки

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

После внесения изменений отправляем их в локальный репозиторий:

# фиксируем все обновлённые файлы в режиме amend
# вместо создания нового коммита
git commit -a --amend

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

# синхронизируем последний код
git checkout master
git pull hugegraph
# перебазируем на основную ветку
git checkout bugfix-branch
git rebase -i master

И снова отправляем его в форк-репозиторий GitHub:

# принудительно отправляем локальный коммит в форк-репо
git push -f origin bugfix-branch:bugfix-branch

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

По любым вопросам обращайтесь к нам по адресу hugegraph@googlegroups.com или через другую контактную информацию.