Внесение вклада в проект Apache Commons FileUpload

Вы обнаружили ошибку или у вас есть идея для новой интересной функции? Внесение кода — отличный способ внести свой вклад в сообщество разработчиков открытого исходного кода. Прежде чем приступить к работе с кодом, необходимо следовать нескольким рекомендациям, чтобы мы могли контролировать ситуацию.

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

• Убедитесь, что у вас есть учётная запись JIRA.
• Убедитесь, что у вас есть учётная запись на GitHub. Это не обязательно, но значительно упрощает предоставление исправлений.
• Если вы планируете реализовать новую функцию, имеет смысл сначала обсудить изменения в списке разработчиков. Таким образом, вы сможете убедиться, что не тратите время на то, что не входит в сферу проекта Apache Commons FileUpload.
• Создайте [билет Jira][jira] для вашей проблемы, если его ещё нет.
  • Подробно опишите проблему, включая шаги для её воспроизведения, если это ошибка.
  • Обязательно укажите самую раннюю версию, в которой, как вам известно, существует проблема.
• Найдите соответствующий репозиторий на GitHub и форк его. Если у вас нет учётной записи на GitHub, вы всё равно можете клонировать репозиторий Commons.

Внесение изменений

• Создайте тематическую ветку для своей изолированной работы.

  • Обычно следует основывать свою ветку на ветке master.
  • Хорошее название тематической ветки может быть идентификатором ошибки JIRA плюс ключевое слово, например, FILEUPLOAD-123-InputStream.
  • Если у вас есть... Представлено несколько задач JIRA, старайтесь поддерживать отдельные ветки и запросы на вытягивание.

• Делайте коммиты логических единиц.

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

• Уважайте оригинальный стиль кода:

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

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

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

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

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

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

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

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

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

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

• Внесение исправлений.
• Страница проекта JIRA Apache Commons FileUpload [jira].
• Лицензионное соглашение участников [cla].
• Общая документация GitHub (https://help.github.com/).
• Документация по запросам на вытягивание GitHub (https://help.github.com/articles/creating-a-pull-request/).
• Аккаунт Apache Commons в Twitter (https://twitter.com/ApacheCommons).