Вклад в проект Apache Commons VFS

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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