Вы нашли ошибку или у вас есть идея для новой крутой функции? Внесение кода — отличный способ вернуть что-то сообществу открытого исходного кода. Прежде чем вы углубитесь в код, есть несколько рекомендаций, которым мы должны следовать участникам, чтобы у нас была возможность быть в курсе происходящего.
Убедитесь, что у вас есть учетная запись JIRA.
Убедитесь, что у вас есть учетная запись GitHub.
Если вы планируете реализовать новую функцию, имеет смысл сначала обсудить ваши изменения в списке разработчиков. Таким образом, вы можете быть уверены, что не тратите свое время на что-то, что не входит в область действия Apache Maven.
Отправьте заявку по вашей проблеме, если она еще не существует.
Четко опишите проблему, включая действия по ее воспроизведению, если это ошибка.
Обязательно заполните самую раннюю версию, в которой, как вам известно, есть проблема.
Форкните репозиторий на GitHub.
Мы принимаем запросы на включение через GitHub. Список рассылки разработчиков — это основной канал связи для участников.
Есть несколько рекомендаций, которые облегчат нам подачу PR:
Создайте тематическую ветку, на которой вы хотите основывать свою работу (обычно это главная ветка). Отправьте свои изменения в тематическую ветку вашего ответвления репозитория.
Сделайте фиксации логических единиц.
Соблюдайте исходный стиль кода: используя один и тот же стиль кода, исправления должны только подчеркивать фактическую разницу, не беспокоясь о каких-либо проблемах с форматированием:
Используйте пробелы только для отступов.
Создавайте минимальные различия — отключайте при сохранении такие действия, как переформатирование исходного кода или организацию импорта. Если вы считаете, что исходный код необходимо переформатировать, создайте отдельный PR для этого изменения.
Перед фиксацией проверьте наличие ненужных пробелов с помощью git diff --check
.
Убедитесь, что ваши сообщения о коммитах имеют правильный формат. Ваше сообщение о фиксации должно содержать ключ проблемы JIRA.
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
Убедитесь, что вы добавили необходимые тесты (JUnit/IT) для ваших изменений.
Запустите все тесты с помощью mvn -Prun-its verify
чтобы убедиться, что ничего не было случайно сломано.
Отправьте запрос на включение в репозиторий организации Apache.
Обновите свой билет JIRA и включите в него ссылку на запрос на включение.
Если вы планируете вносить вклад на регулярной основе, рассмотрите возможность заключения лицензионного соглашения для участников.
Для изменений тривиального характера в комментариях и документации не всегда необходимо создавать новый тикет в JIRA. В этом случае уместно начать первую строку коммита с «(doc)» вместо номера заявки.
Внесение патчей
Страница проекта общих компонентов Apache Maven
Лицензионное соглашение для участников
Общая документация GitHub
Документация по запросу на GitHub
Учетная запись Apache Maven в Твиттере
IRC-канал #Maven на сайте freenode.org