Вклад в проект

Благодарим вас за интерес к участию! Этот документ содержит конкретные детали вклада в nats-io/nats-server. Если вы впервые вносите свой вклад, пожалуйста, обратитесь к общему Руководству для участников NATS, чтобы получить исчерпывающий обзор участия в проекте NATS.

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

Есть три основных способа внести свой вклад в этот репозиторий:

• Предложить улучшение или новую функцию;
• Сообщить об ошибке или регрессии;
• Внести изменения в исходный код.

Для первых двух способов обратитесь к проблемам GitHub, которые помогут вам выбрать доступные варианты и собрать необходимую информацию.

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

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

Предложение изменений исходного кода осуществляется через стандартный рабочий процесс запросов на вытягивание GitHub.

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

Это отложит автоматический процесс запроса проверки от команды NATS и значительно уменьшит шум, пока вы не будете готовы. Как только вы будете довольны, вы можете нажать кнопку «Готов к проверке».

Рекомендации

Хороший запрос на вытягивание включает:

• Общее описание изменений, включая ссылки на любые проблемы, связанные с добавлением комментариев типа «Решает №NNN» в ваше описание. Дополнительную информацию см. в разделе «Связывание запроса на вытягивание с проблемой».
• Актуальный родительский коммит. Пожалуйста, убедитесь, что вы используете последнюю версию основной ветки и перебазируете свою работу поверх неё, т. е. git rebase main.
• Модульные тесты, где это уместно. Исправления ошибок выиграют от добавления регрессионных тестов. Новые функции не будут приняты без соответствующего тестового покрытия!
• Не более коммитов, чем необходимо. Иногда наличие нескольких коммитов полезно для рассказа истории или изоляции изменений друг от друга, но, пожалуйста, объедините все ненужные коммиты, которые могут быть просто для очистки, комментариев или небольших изменений.
• Никаких дополнительных внешних зависимостей, которые не являются абсолютно необходимыми. Пожалуйста, сделайте всё возможное, чтобы избежать включения дополнительных библиотек/зависимостей в go.mod, поскольку мы будем очень критичны к ним.

Подпись

Чтобы принять участие, вам сначала нужно подтвердить, что вклад является вашей оригинальной работой и что вы лицензируете работу проекту под лицензией Apache-2.0.

Это делается с помощью утверждений Signed-off-by, которые должны появляться как в ваших сообщениях о фиксации, так и в описании вашего PR. Обратите внимание, что мы можем принимать подписи только под юридическим именем. Никнеймы и псевдонимы не допускаются.

Чтобы выполнить подпись с помощью git, используйте git commit -s (или --signoff).

Получить помощь

Если у вас есть вопросы о процессе участия, пожалуйста, создайте обсуждение на GitHub, присоединитесь к NATS Slack или отправьте свой вопрос в Google Group NATS.