Руководство по вкладу в проект Infinispan

Вклад сообщества необходим для поддержания сильной и успешной работы Infinispan.

Это руководство сосредоточено на том, как вносить изменения обратно в Infinispan с помощью pull request на GitHub. Если вам требуется помощь с клонированием, компиляцией или установкой проекта в среде разработки, пожалуйста, обратитесь к нашему руководству по вкладу.

Юридическая информация

Все первоначальные вклады в Infinispan лицензированы под лицензией Apache Software License (ASL), версия 2.0 или более поздняя версия, или, если другая лицензия указана как регулирующая файл или директорию, которую вы модифицируете, то такая другая лицензия.

Все вклады подчинены Developer Certificate of Origin (DCO). Текст DCO также приведён в полном объёме в файле dco.txt в корневой директории репозитория.

Начало работы

Если вы только начинаете работать с Git, GitHub и/или вкладом в Infinispan, есть несколько обязательных шагов:

• Убедитесь, что у вас есть аккаунт на GitHub
• Создайте форк репозитория Infinispan repository. Как указано на связанной странице, это также включает:
  • Настройте ваш локальный установщик Git
  • Клонируйте свой форк## Создание тестового случая

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

Просто создайте форк репозитория, создайте ваш тестовый случай и прикрепите его как архив к тикету.

Создание тематической ветки

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

git checkout -b bk_12345 origin/main

Код

Напишите код...

Правила оформления и соглашения стиля

Проекты семьи Infinispan используют одни и те же соглашения стиля. Для получения более подробной информации обратитесь к нашему руководству по вкладу.

Отладка

Если вам требуется отладить тест, выполняющийся внутри контейнера, такой как тесты в server/tests, вы должны запустить отладчик в режиме прослушивания/сервера на порту 5005. Установите все необходимые точки останова и затем запустите тест с системной свойством org.infinispan.test.server.container.debug, установленной на индекс контейнера, который вы хотите отладить (обычно 0 для первого контейнера):

java -Dorg.infinispan.test.server.container.debug=0 ...

mvn verify -pl server/tests -Dit.test=RequestTracingIT -Dorg.infinispan.test.server.container.debug=0

## Подтверждение

* Создайте коммиты логических единиц.
* Убедитесь, что вы начинаете сообщения о коммитах с ключом задачи, над которой работаете. Это позволяет легко ссылаться на задачи на GitHub.
* Избегайте изменения форматирования существующего кода по возможности: они делают намерение вашего патча менее понятным.
* Убедитесь, что вы добавили необходимые тесты для ваших изменений.
* Выполните _все_ тесты, чтобы убедиться, что ничего другого случайно не сломалось:

```shell
mvn verify

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

Добавьте оригинальный репозиторий Infinispan как удалённый репозиторий с названием upstream:

git remote add upstream git@github.com:infinispan/infinispan.git

Если вы хотите переотрисовать вашу ветвь поверх основной ветви, вы можете использовать следующую команду Git:

git pull --rebase upstream main

Отправка

• Отправьте свои изменения в тематическую ветвь в форке репозитория.
• Инициируйте предложение слияния.
• Ссылайтесь на ключ задачи в описании предложения слияния.