Должен ли я создать запрос на вытягивание (PR)?

Благодарим за предложение помочь. Мы действительно ценим ваши намерения. Но давайте рассмотрим, действительно ли создание запроса на вытягивание (PR) является разумным шагом в том, что вы пытаетесь сделать.

• Вы заметили опечатку или небольшую ошибку, которую считаете очень простой для исправления? Создание PR идеально подходит. Переходим к "Идеальный PR".
• Хотите показать некоторый код в форме разницы/PR? Конечно! Это умное использование PR, часто лучше, чем проза. Если нет ожиданий его слияния, делайте это!
• Планируете предложить конкретную реализацию нового функционала, API и т.д.? Пожалуйста, не делайте этого! Мы очень вероятно отклоним ваш PR, и вы потратите время зря. Пожалуйста, используйте систему отслеживания проблем или электронную почту для обсуждения ваших идей сначала. Затем, вполне возможно, будет гораздо более разумно оставить реализацию за нами. Вот почему:

Пропущенные моменты

Во-первых, согласно нашему опыту, большинство участников пропускают множество вещей. Это потому, что jOOQ стал довольно сложным за последние десять лет. Они будут применять небольшие изменения к частям API без учета...

• всех остальных частей API, связанных с аналогичными темами, которые также должны быть учтены,
• второстепенных функций, таких как парсер (и его грамматика), который также должен быть обновлен,
• существующих функций, которые следует объединить с этой одной,
• возможных устареваний, которые требуют реализации,
• обратной совместимости во многих тонких аспектах (источника, бинарной, поведенческой),
• множества мест в руководстве, которые требуют обновления,
• того факта, что jOOQ имеет двойную лицензию, и ваш вклад может не работать на коммерческих базах данных (но он должен, так что это снова станет нашей задачей).

Кроме того:

• тесты не являются открытыми исходниками, поэтому вы не можете проверить свой вклад самостоятельно, ни доказать, что он надежен, через тесты,
• руководство не является открытым исходником, поэтому вы не сможете внести свой вклад,
• коммерческие распределения не являются открытыми исходниками, и возможно, там требуется другое выполнение.

Часто достаточно простых обходных решений

Но еще важнее, просто потому, что у вас есть желание сейчас, не значит, что ее нужно удовлетворить сразу (с новым API). Вероятно, простое обходное решение справится с этим так же хорошо для вас, и оно не вызовет всех вышеупомянутых усилий как со стороны вашего проекта, так и со стороны нашего. В действительности, мы стали очень хорошими в составлении 3-4 полезных обходных решений (используя функции, которые вы, возможно, пока не знали) для почти любой проблемы (которую мы, скорее всего, уже видели раньше). Просто потому, что вы собираетесь создать PR, не значит, что мы будем придавать ему высший приоритет. На самом деле, опыт показывает, что мы крайне редко вообще принимаем эти PR!

Проектная дорожная карта

Со временем мы запомним многие жалобы пользователей jOOQ и объединим их в новый функционал, который поможет многим другим пользователям, а не только вашей текущей потребности. Он будет гораздо легче поддерживать и иметь лучшее качество.

Увы, GitHub не позволяет активировать систему отслеживания проблем (отлично сделанную и полезную) без активации системы PR (что кажется намеком пользователям, что они могут вносить любые предложения к кому угодно и разумно ожидать, что их вклад будет принят). Подумайте о OpenJDK. Вы бы предлагали массу новых методов для API java.util.Collection без предварительного обсуждения на многих электронных списках OpenJDK? Вероятно, нет. То же самое здесь.

Большое спасибо за понимание, и мы действительно с нетерпением ждем ваших предложений и обсуждений на системе отслеживания проблем или на электронной почте

Идеальный PR

Еще раз благодарим за предложение помочь. Этот раздел предназначен для PR, которые исправляют простые проблемы, которые не требуют никакого обсуждения — такие как опечатки, небольшие ошибки и т.д.

Чтобы сделать нашу кооперацию максимально эффективной, у нас есть несколько правил, которые мы хотели бы, чтобы вы следовали:

• Если у вас есть сомнения, пожалуйста, обсудите свои идеи перед предоставлением запроса на вытягивание. Смотрите выше.
• Разветвите репозиторий.
• Проверьте и работайте на своем разветвлении.
• Постарайтесь делать ваши коммиты как можно более атомарными. Относительно изменения трёх файлов должно быть сделано один коммит.
• Сообщение коммита должно ссылаться на номер проблемы, например, [#5873] Добавление Setting.quoteEscaping для возможности альтернативного экранирования одиночных кавычек.
• Постарайтесь не модифицировать ничего не связанного, то есть не меняйте незначительные пробелы / форматирование, которое лишь отвлекает во время проверки.
• В особенности, пожалуйста, не убирайте лишние пробелы / ненужные импорты и т.д. Версия jOOQ Open Source Edition является "производной клоном" коммерческих распределений jOOQ. Мы хотели бы сохранить все номера строк между двумя версиями!
• Не беспокойтесь о тестах. Наша единичная и интеграционная тесты не являются открытыми исходниками. Если ваша изменение значительна, мы добавим тесты сами.
• Добавьте свое имя в наш jOOQ/src/main/resources/META-INF/ABOUT.txt файл
• Убедитесь, что вы согласны передать права на ваш вклад нам (Data Geekery GmbH), прежде чем вносить вклад.Внесение вклада в двойную лицензированную открытую программу ===========================================================

Огромное спасибо за ваш вклад в jOOQ.

jOOQ — это двойная лицензированная программа. Хотя версия, опубликованная здесь на GitHub, лицензируется по ASL Yöntem 2.0, мы также распространяем jOOQ под коммерческой лицензией для тех клиентов, кто хочет использовать jOOQ с коммерческими базами данных. Для получения дополнительной информации о коммерческой лицензии, пожалуйста, обратитесь к этому сайту: http://www.jooq.org/legal/licensing

Наши двойные лицензии означают, что нам необходима передача всех прав на ваш вклад вам, Data Geekery GmbH, чтобы мы могли перелицензировать ваш вклад также для наших коммерческих клиентов, если ваш вклад состоит из одного из следующего:

• Исходный код для внедрения в доставки jOOQ;
• Исходный код для внедрения в интеграционные тесты jOOQ;
• Содержимое для внедрения в нашу документацию;

Передача прав не требуется для следующего:

• Жалобы на ошибки;
• Запросы на новые функции и обсуждения;
• Примеры кода для воспроизведения ошибок (например, через https://github.com/jOOQ/jOOQ-mcve);

Если ваш вклад требует передачи прав, пожалуйста, подпишите следующий документ до продолжения: http://www.jooq.org/legal/contributions

Огромное спасибо ещё раз за ваш вклад, Команда jOOQ