Вклад в Apache Commons Math

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

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

• Убедитесь, что у вас есть учётная запись JIRA (https://issues.apache.org/jira/).
• Убедитесь, что у вас есть учётная запись GitHub (https://github.com/signup/free).
• Если вы планируете реализовать новую функцию, имеет смысл сначала обсудить изменения в списке разработчиков (https://commons.apache.org/mail-lists.html). Таким образом, вы можете быть уверены, что не тратите время на то, что не входит в сферу деятельности Apache Commons Math.
• Отправьте заявку Jira jira для вашей проблемы, если она ещё не существует.
  • Четко опишите проблему, включая шаги для воспроизведения, когда это ошибка.
  • Обязательно укажите самую раннюю версию, в которой, как вам известно, есть проблема.
• Найдите соответствующий репозиторий на GitHub (https://github.com/apache/?query=commons-) и создайте его форк. Проверьте свой разветвлённый репозиторий.

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

• Создайте тематическую ветку для своей изолированной работы.
  • Обычно следует основывать свою ветку на ветке master или trunk.
  • Хорошее название тематической ветки может быть идентификатором ошибки JIRA плюс ключевое слово, например, MATH-123-InputStream.
  • Если вы отправили несколько заявок JIRA, попробуйте поддерживать отдельные ветки и запросы на вытягивание.
• Делайте коммиты логических единиц.
  • Убедитесь, что ваши сообщения о коммитах соответствуют стандартам. Внесение изменений

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

• Например: «MATH-123: закрыть входной поток раньше»*

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

  • Используйте только пробелы для отступов.

  • Создавайте минимальные различия — отключите действия On Save, такие как Reformat Source Code или Organize Imports. Если вы считаете, что исходный код следует переформатировать, сначала создайте отдельный 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.

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

• Внесение исправлений.

• Страница проекта JIRA Apache Commons Math jira.

• Лицензионное соглашение участника cla.

• Общая документация GitHub [general github documentation].

• Документация по запросу на вытягивание GitHub [github pull request documentation].

• Аккаунт Apache Commons в Twitter [apache commons twitter account].

• Канал #apache-commons IRC на irc.freenode.net.