Процесс работы

• Комментарии должны быть содержательными и оформлены надлежащим образом. В сообщении о фиксации изменений должен быть указан ключ проблемы JIRA.

  • Например: BEANUTILS-123: Закрыть входной поток раньше.

• Соблюдайте оригинальный стиль кода:

  • Используйте только пробелы для отступов.
  • Создавайте минимальные различия — отключите действия «Сохранить» вроде «Переформатировать исходный код» или «Организовать импорт». Если вы считаете, что исходный код следует переформатировать, сначала создайте отдельный PR для этого изменения.
  • Проверьте наличие лишних пробелов с помощью команды git diff перед фиксацией.

• Убедитесь, что вы добавили необходимые тесты для ваших изменений, обычно в src/test/java.

• Запустите все тесты с помощью mvn clean verify, чтобы убедиться, что случайно ничего не сломалось.

Внесение тривиальных изменений

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

В случае тривиальных изменений комментариев и документации не всегда необходимо создавать новую проблему в JIRA. В этом случае уместно начать первую строку фиксации с '(doc)' вместо номера билета.

Отправка изменений

• Подпишите и отправьте Лицензионное соглашение участника, если вы ещё этого не сделали. Обратите внимание, что небольшие патчи и типичные исправления ошибок не требуют CLA, поскольку они охватываются пунктом 5 Apache License.

• Отправьте свои изменения в тематическую ветку вашего форка репозитория.

• Отправьте Pull Request в соответствующий репозиторий в организации apache. Убедитесь, что Files Changed показывает только ваши предполагаемые изменения и не включает дополнительные файлы вроде target/*.class.

• Обновите свою проблему JIRA и включите ссылку на запрос на вытягивание в билет.

Если вы предпочитаете не использовать GitHub, вы можете вместо этого использовать git format-patch (или svn diff) и прикрепить файл патча к проблеме JIRA.