Руководство по внесению вклада

При обнаружении ошибки

• Убедитесь, что ошибка ещё не была зарегистрирована, выполнив поиск на GitHub в разделе Issues.

• Если проблема не решена, создайте новую. Обязательно укажите заголовок, начинающийся с «[bug]», и подробное описание, предоставьте как можно больше релевантной информации, а также пример кода или исполняемый тестовый случай, демонстрирующий ожидаемое поведение, которое не происходит.

Напишите патч, который исправляет ошибку

• Создайте новый запрос на вытягивание (pull request) на GitHub с патчем.

• Убедитесь, что описание PR чётко описывает проблему и решение. Укажите номер соответствующей проблемы, если это применимо.

• Перед отправкой убедитесь, что описание коммита начинается с:

  • [add], если были добавлены новые функции.
  • [dev], если код был изменён.
  • [fix], если ошибки были исправлены.
  • [misc], если некоторые изменения были внесены и ошибки были исправлены.

• Обеспечьте соответствие кода соглашениям:

  • Все файлы начинаются с «ngx_».
  • В заголовочных файлах используются #ifndef _FILE_NAME_H_INCLUDED_, #define _FILE_NAME_H_INCLUDED_ и #endif.
  • Предпочтительно использовать комментарии в стиле /* ... */.
  • Лучше, чтобы встроенные типы появлялись перед пользовательскими типами.
  • Между типами и переменными должно быть не менее 2 пробелов.
  • Переменные выравниваются по символам, а не по знакам *.
  • Не более 80 символов в одной строке кода или комментария.
  • Две пустые строки между двумя функциями, стили макросов и определений типов такие же, как у функций.

Добавьте новую функцию или измените существующую

• Откройте вопрос на GitHub, начиная с «[feature]», пока не соберёте положительные отзывы об изменениях.

Вопросы о исходном коде

• Откройте вопрос на GitHub, начиная с «[misc]», опишите его как можно более подробно.

Спасибо!

Winshining