Внесение вклада в проект JanusGraph

Спасибо за ваше желание внести вклад в проект JanusGraph. Как сообщество с открытым исходным кодом, мы высоко ценим внешние вклады в наш проект.

Чтобы сделать процесс удобным как для commit-owners (тех, кто проверяет и принимает изменения), так и для вкладчиков (тех, кто предлагает новые изменения через pull request), существуют несколько правил, которые следует соблюдать.

Подпишите CLA

Перед тем как вы сможете вносить вклад в JanusGraph, пожалуйста, подпишите Договор о вкладе (Contributor License Agreement, CLA). Это не передача авторских прав, это просто предоставление JanusGraph права использовать и распространять ваши вклады как часть проекта.

• Если вы являетесь индивидуальным автором оригинального исходного кода и уверены, что владеете интеллектуальной собственностью, вам потребуется следовать инструкциям для индивидуального вкладчика.* Если вы работаете в компании или организации, которая может претендовать на интеллектуальную собственность, которую вы можете создать, и организация хочет позволить вам делать вклады, то авторизованному представителю организации потребуется следовать инструкциям для менеджера CLA. Вкладчики должны будут следовать инструкциям для корпоративного вкладчика.## Создайте форк репозитория на GitHub

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

Клонируйте свой форк локально

Для клонирования репозитория локально используйте один из следующих методов:

• если вы настроили и используете ключ SSH, выполните команду:

  $ git clone git@github.com:$USER/janusgraph

• в противном случае, чтобы использовать HTTPS-перенос, выполните команду:

  $ git clone https://github.com/$USER/janusgraph

Добавьте оригинальный репозиторий для синхронизации новых изменений:

$ git remote add upstream git@github.com:JanusGraph/janusgraph

Не делайте вклады в ветку main вашего собственного форка. Также не отправляйте свои рабочие, незавершенные или ветки PR на JanusGraph/janusgraph; вместо этого используйте свой собственный форк.

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

$ git remote set-url --push upstream do-not-push

Настройка вашего репозитория для соответствия CLA

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

Чтобы настроить их, используйте следующие команды```bash $ cd janusgraph $ git config user.name "Мое Имя" $ git config user.email "my-email@example.com"

> Примечание: если вы забудете использовать правильный адрес электронной почты первый раз, и
> @janusgraph-bot добавляет метку `[cla: no]` к вашему PR, вы можете исправить это на месте
> при использовании существующего PR следующим образом:
>
> * установите свое имя и электронную почту согласно вышеуказанному
> * выполните следующие команды:
>
>   ```bash
>   $ git commit --amend -s --reset-author
>   $ git push -f
>   ```

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

Не разрабатывайте на выпусковой ветке, такой как `master`: ветки функциональностей должны быть легковесными и удаляться после слияния с основным репозиторием, но вы не должны удалять свою выпусковую ветку, поэтому не используйте её для разработки.

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

```bash
$ git checkout master
$ git pull --ff-only upstream master
$ git checkout -b my-new-feature

JanusGraph использует стратегию обратной совместимости, чтобы гарантировать, что изменения могут применяться ко всем выпусковым веткам, которые все ещё поддерживаются. Это значит, что ветка функциональности всегда должна создаваться от master.

Разработка и тестирование ваших изменений

Сделайте эту функцию или исправление ошибки отличной!

Изменение конфигураций

Если вы добавили любую конфигурацию или изменили любую конфигурацию, вам нужно обновить docs/configs/janusgraph-cfg.md. Для обновления справочной информации о конфигурациях используйте следующую команду:

mvn --quiet clean install -DskipTests=true -pl janusgraph-doc -am

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

Коммит изменений и подписание Договора Оригинальности Разработчика

Фонд Linux требует, чтобы каждый участник проектов фонда подписал Договор Оригинальности Разработчика, также доступный в этом репозитории как DCO.txt. Чтобы подписать его, просто используйте команду commit -s:

$ git add [...files...]
$ git commit -s

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

$ git commit --amend -s
$ git push -f

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

$ git config alias.ci 'commit -s'

С этим псевдонимом, отныне вы сможете просто выполнить:

$ git ci

чтобы сделать коммит файлов, и это автоматически добавит ключ -s, чтобы гарантировать, что ваш вклад был подписан.

Примечание: поскольку это псевдоним, вы всё ещё можете добавлять флаги к командной строке, например, git ci -v покажет вам разницу ваших изменений при записи сообщения коммита.## Отправьте свои изменения на ваш форк GitHub

$ git push

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

После того как вы сделаете это один раз для этого ветвь, вы сможете использовать git push для добавления дополнительных изменений.

Создайте запрос на слияние

Перейдите на страницу репозитория JanusGraph и вы должны заметить, что система предложит вам сравнить недавно отправленный ветвь с текущим ветвём master JanusGraph и отправить запрос на слияние одновременно.

Прочитайте лист проверки PR для критериев приемлемых вкладов.

Обзор кода

Если вы подписали CLA, вы должны пройти проверку EasyCLA.

Если вы видите, что проверка CLA не прошла, будет комментарий от EasyCLA с ссылкой на подписание CLA. Убедитесь, что ваш CLA и ваши имя, адрес электронной почты и имя пользователя GitHub совпадают, для всех коммитов в вашем запросе на слияние.

Если вы не уверены, что именно не так, свяжитесь с janusgraph-cla@googlegroups.com с дальнейшими вопросами.

Обзор кодаJanusGraph использует Codacy для статического анализа запросов на слияние, чтобы обеспечить качество кода. Codacy создает встроенные комментарии для пунктов, требующих внимания, и может генерировать большое количество потенциально нежелательных уведомлений. Добавление пользователя codacy-bot в список заблокированных пользователей прекратит эти уведомления.