Вклад в dotNetty

dotNetty — это большой проект, и мы будем рады вашему вкладу, поэтому спасибо за желание внести свой вклад в dotNetty!

Контрольный список перед созданием запроса на вытягивание (Pull Request)

Отправьте только релевантные коммиты. Мы не против большого количества коммитов в запросе на вытягивание, но они должны быть релевантными, как описано ниже.

• Используйте ветку функций. Запрос на вытягивание должен быть создан из ветки функций, а не из dev. Смотрите ниже, почему.
• Никаких merge-коммитов. Если у вас есть коммиты, которые выглядят так: «Объединить ветку 'my-branch' в dev» или «Объединить ветку 'dev' из https://github.com/Azure/DotNetty в dev», вы, вероятно, используете слияние вместо перебазирования локально. Смотрите ниже раздел «Обработка обновлений от вышестоящего источника».
• Сжимайте коммиты. Часто мы создаём временные коммиты типа «Начал реализовывать функцию x» и затем «Ещё немного поработал над функцией x». Сжимайте эти коммиты вместе с помощью интерактивного перебазирования. Также смотрите Сжатие коммитов с помощью перебазирования.
• Описательные сообщения о коммитах. Если сообщение о коммите не является описательным, измените его с помощью интерактивного перебазирования. Указывайте проблемы с использованием #issue. Пример плохого сообщения: «Небольшая очистка». Пример хорошего сообщения: «Удалил заголовок Security.Claims из FSM, что нарушило сборку Mono согласно #62». Не бойтесь писать длинные сообщения, если это необходимо. Постарайтесь объяснить, почему вы внесли изменения. В репозитории Erlang есть информация о написании хороших сообщений о коммитах.
• Не делайте один коммит, чтобы править всеми. Большие коммиты, изменяющие слишком много вещей одновременно, очень трудно проверить. Разделите большие коммиты на более мелкие. Смотрите этот вопрос StackOverflow для получения информации о том, как это сделать.
• Тесты. Добавьте соответствующие тесты и убедитесь, что все существующие всё ещё проходят. Тесты можно запустить с помощью команды.
• Отсутствие предупреждений. Убедитесь, что ваш код не выдаёт никаких предупреждений при сборке.

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

Заголовок и описание запроса на вытягивание

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

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

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

Убедитесь, что у вас есть учётная запись GitHub.

• Форк, клонируйте, добавьте вышестоящий источник в репозиторий dotNetty. Смотрите Форк репозитория для более подробных инструкций или следуйте приведённым ниже инструкциям.

• Сделайте форк, нажав кнопку Fork на странице https://github.com/Azure/DotNetty.

• Клонируйте свой форк локально.

git clone https://github.com/YOUR-USERNAME/DotNetty

• Добавьте вышестоящий удалённый сервер.

git remote add upstream https://github.com/Azure/DotNetty

Теперь у вас есть два пульта: upstream указывает на https://github.com/Azure/DotNetty, а origin указывает на ваш форк на GitHub.

• Внесите изменения. Смотрите ниже.

Не знаете, с чего начать? Проблемы, помеченные как up for grabs, — это то, чем мы хотим помочь.

Смотрите также: Вклад в проекты с открытым исходным кодом на GitHub

Новичок в Git? Смотрите https://help.github.com/articles/what-are-other-good-resources-for-learning-git-and-github

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

Никогда не работайте напрямую с dev или master, и вы никогда не должны отправлять запрос на вытягивание с мастера — всегда с созданной вами ветки функций.

• Выберите проблему. Если проблемы не существует (сначала выполните поиск).