Внесение вклада в Apache Commons Digester

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

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

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

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

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

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

• Выполняйте коммиты логических единиц.

  • Убедитесь, что ваши сообщения о коммите имеют смысл и соответствуют формату. Ваше сообщение о коммите должно содержать ключ задачи JIRA.
  • Например: DIGESTER-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 Digester JIRA
• Лицензионное соглашение участника CLA
• Общая документация GitHub (https://help.github.com/)
• Документация по запросам на вытягивание GitHub (https://help.github.com/articles/creating-a-pull-request/)
• Аккаунт Apache Commons в Twitter (https://twitter.com/ApacheCommons)