Разделение веток и пул-реквестов

• Делите код на логические блоки и фиксируйте их.

  • Убедитесь, что ваши коммиты осмысленны и оформлены правильно. В сообщении коммита должен быть указан ключ задачи JIRA.
    • Например: CODEC-123: Закрыть входной поток раньше.

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

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

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

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

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

Задачи JIRA используются для создания журнала изменений для следующего релиза.

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

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

• Подпишите и отправьте Лицензионное соглашение участника Apache [CLA], если вы ещё этого не сделали.
  • Обратите внимание, что небольшие патчи и типичные исправления ошибок не требуют CLA, так как пункт 5 Apache License покрывает их.
• Отправьте свои изменения в тематическую ветку вашего форка репозитория.
• Создайте Pull Request в соответствующий репозиторий в организации apache.
  • Проверьте, что в разделе «Изменённые файлы» отображаются только ваши предполагаемые изменения и не включаются дополнительные файлы, такие как target/*.class.
• Обновите свою задачу JIRA и добавьте ссылку на пул-реквест в тикет.

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

Дополнительные ресурсы

• Внесение исправлений.
• Страница проекта JIRA Apache Commons Codec [jira].
• Лицензионное соглашение участника [CLA].
• Общая документация GitHub [general].
• Документация по созданию пул-реквеста на GitHub [pull].
• Аккаунт Apache Commons в Twitter [twitter].